frameRateMonitor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once


#include "vrfcore/vrfcoreDefines.h"
#include <vlutil/vlString.h>
#include <vl/hostStructs.h>
#include <vector>

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


class DT_DLL_vrfcore DtFrameRateMonitor
{
private:
   DtFrameRateMonitor();

   DtFrameRateMonitor(const DtFrameRateMonitor& orig);

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

public:
   typedef std::vector<DtSimulationAddress> DtFrameRateRequesters;
   typedef DtFrameRateRequesters::iterator DtFrameRateRequestersIter;
   typedef DtFrameRateRequesters::const_iterator DtFrameRateRequestersConstIter;

   DtFrameRateMonitor(DtSimManager* simManager);

   virtual bool init();

   virtual bool registerInterfaceCallbacks();

   virtual double meanFrameRate(int section = -1);

   virtual double medianFrameRate(int section = -1);

   virtual double standardDeviationFrameRate(int section = -1);

   virtual double minimumFrameRate(int section = -1);

   virtual double maximumFrameRate(int section = -1);

   virtual double simTimeToRealTimeRatio();

   virtual int numSections() const;

   virtual int section(int index) const;

   virtual std::vector<int> sections() const;

   virtual double lastSample(int section = -1);

   virtual void reset(bool sendReport = false);

   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 void setTickingPublishersDuringObjectTick(bool);
   virtual bool tickingPublishersDuringObjectTick() const;

   virtual bool hasRequestors() const;

   virtual void setTimeMultiplier(double d);

   virtual void processFrameRateRequestMessage(DtSimInterfaceMessage* message);
   virtual void processPingRequest(DtSimInterfaceMessage* message);
   virtual void processModifyPerformanceSettings(DtSimInterfaceMessage*);

   virtual void generateReport();

   virtual ~DtFrameRateMonitor();

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

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

protected:

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

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

   DtFrameRateRequesters myRequesters;

   short myNumberOfCPUs;
   double myTimeMultiplier;
   bool myTickingPublishersDuringObjectTick;

   bool     myIsPaused;
};