ifFrameRateResponse.h

Go to the documentation of this file.

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



#pragma once

#include <vlutil/vlString.h>
#include <vrfutil/backend.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlutil/vlNetTypes.h>
#include <map>

#include "vrfmsgs/vrfmsgsDefines.h"
class DT_DLL_vrfmsgs DtIfFrameRateResponse : public DtSimInterfaceContent
{
public:
   DtIfFrameRateResponse();

   DtIfFrameRateResponse(const DtIfFrameRateResponse & orig);

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

   virtual ~DtIfFrameRateResponse() override;

   virtual int type() const override;

   virtual DtSimInterfaceContent * clone() const override;

   virtual int numSections() const;
   
   virtual int section(int) const;

   const DtBackend::SectionTimes& sectionTimes() const
   {
      return mySectionTimes;
   }

   virtual double frameRateMean(int section) const;
   virtual void setFrameRateMean(int section, double frameRateMean);

   virtual double frameRateMedian(int section) const;
   virtual void setFrameRateMedian(int section, double frameRateMedian);

   virtual double frameRateStandardDeviation(int section) const;
   virtual void setFrameRateStandardDeviation(int section, double 
      frameRateStandardDeviation);

   virtual double minFrameRate(int section) const;
   virtual void setMinFrameRate(int section, double minFrameRate);

   virtual double maxFrameRate(int section) const;
   virtual void setMaxFrameRate(int section, double maxFrameRate);

   virtual double frameRateResponsePeriod();
   virtual void setFrameRateResponsePeriod(double period);

   virtual unsigned int framesAveraged();
   virtual void setFramesAveraged(unsigned int frames);

   virtual double simTimeToRealTimeRatio();
   virtual void setSimTimeToRealTimeRatio(double ratio);

   virtual void setNumberOfTickThreads(short);
   virtual short numberOfTickThreads() const;

   virtual void setNumberOfCPUs(short);
   virtual short numberOfCPUs() const;

   virtual void setTickingPublishersDuringObjectTick(bool);
   virtual bool tickingPublishersDuringObjectTick() const;

   virtual int netRepSize() const override;
   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
   virtual bool setToNet() override;

   virtual void printDataToString(DtString& str) override;

   static DtSimInterfaceContent* creator();

protected:
   DtBackend::SectionTimes mySectionTimes;
   DtFloat64 myFrameRateResponsePeriod;
   DtU32 myFramesAveraged;
   DtFloat64 mySimTimeToRealTimeRatio;
   DtU16 myNumberOfTickThreads;
   DtU16 myNumberOfCPUs;
   bool myTickingPublishersDuringObjectTick;
};