frameRateMonitor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999-2000 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: frameRateMon.h,v $ $Revision: 1.19 $ $State: Exp $
*******************************************************************************/
#ifndef frameRateMonitor_H_
#define frameRateMonitor_H_



#include <vlutil/vlString.h>
#include <vl/hostStructs.h>
#include <vector>
#include "vrfutil/averager.h"

class DtPeriodicTimer;
class DtSimManager;
class DtSimInterfaceMessage;
class DtSimMessage;
class DtTimer;

#include "vrfcore/vrfcoreDefines.h"
class DT_DLL_vrfcore DtFrameRateMonitor
{
public:
   typedef std::vector<DtSimulationAddress> DtFrameRateRequesters;
   typedef DtFrameRateRequesters::iterator DtFrameRateRequestersIter;
   typedef DtFrameRateRequesters::const_iterator DtFrameRateRequestersConstIter;

   DtFrameRateMonitor();

   DtFrameRateMonitor(DtSimManager* simManager);

   DtFrameRateMonitor(const DtFrameRateMonitor& orig);

   const DtFrameRateMonitor& operator=(const DtFrameRateMonitor& orig);

   virtual bool init();

   virtual void setSimManager(DtSimManager* simManager);

   virtual bool registerInterfaceCallbacks();

   virtual double meanFrameRate();

   virtual double medianFrameRate();

   virtual double standardDeviationFrameRate();

   virtual double minimumFrameRate();

   virtual double maximumFrameRate();

   virtual double simTimeToRealTimeRatio();

   virtual void addSample(double frameTime);

   virtual double lastSample() const;

   virtual void reset(bool sendReport = false);

   virtual void setNumberOfFramesToAverage(unsigned int numFramesToAverage);
   virtual unsigned int numberOfFramesToAverage();

   virtual void setReportMean(bool reportMean);
   virtual bool reportMean() const;

   virtual void setReportMedian(bool reportMedian);
   virtual bool reportMedian() const;

   virtual void setReportStandardDeviation(bool reportStandardDeviation);
   virtual bool reportStandardDeviation() const;

   virtual void setReportMinimum(bool reportMinimum);
   virtual bool reportMinimum() const;

   virtual void setReportMaximum(bool reportMaximum);
   virtual bool reportMaximum() const;

   virtual void setReportToConsole(bool reportToConsole);
   virtual bool reportToConsole() const;

   virtual void setReportSimTimeToRealTimeRatio(bool reportSimTimeToRealTimeRatio);
   virtual bool reportSimTimeToRealTimeRatio() const;

   virtual bool hasRequestors() const;

   virtual void processFrameRateRequestMessage(DtSimInterfaceMessage* message);

   virtual void generateReport();

   virtual void pause();
   virtual void resume();

   virtual bool isPaused() const;

   virtual ~DtFrameRateMonitor();

   static void frameRateRequestCallback(DtSimMessage* msg, void* usr);
   static void reportTimerCallback(DtTimer* timer);

protected:
   virtual void removeTimer();
   virtual void setTimer(double period);

protected:

   double myCurrentFrameRate;

   bool myReportMeanFlag;
   bool myReportMedianFlag;
   bool myReportStandardDeviationFlag;
   bool myReportMinimumFlag;
   bool myReportMaximumFlag;
   bool myReportToConsoleFlag;
   bool myReportSimTimeToRealTimeRatioFlag;

   DtAverager myAverager;

   DtSimManager* mySimManager;
   DtPeriodicTimer* myReportTimer;
   double   myCurrentResponsePeriod;
   DtTime myLastReportTimerCbSimTime;
   DtTime myLastReportTimerCbRealTime;
   DtTime mySimTimeRealTimeRatio;

   DtFrameRateRequesters myRequesters;

private:
   bool     myIsPaused;
};


#endif