DtIfFrameRateResponse Class Reference

File: ifFrameRateRsp.h.

Class: DtIfFrameRateResponse DtIfFrameRateResponse is the content portion of a frame rate response message. It is sent in response (either once or periodically) to a frame rate request message.

Content-Type: DtFrameRateResponseMessageType

Inheritance diagram for DtIfFrameRateResponse:

Public Member Functions
	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
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 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
virtual double	simTimeToRealTimeRatio ()
virtual void	setSimTimeToRealTimeRatio (double ratio)
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtBackend::SectionTimes	mySectionTimes
DtFloat64	myFrameRateResponsePeriod
DtU32	myFramesAveraged
DtFloat64	mySimTimeToRealTimeRatio
DtU16	myNumberOfTickThreads
DtU16	myNumberOfCPUs
bool	myTickingPublishersDuringObjectTick
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfFrameRateResponse::DtIfFrameRateResponse

(

)

default constructor

DtIfFrameRateResponse::DtIfFrameRateResponse

(

const DtIfFrameRateResponse &

orig

)

copy constructor

virtual DtIfFrameRateResponse::~DtIfFrameRateResponse ( )

overridevirtual

Member Function Documentation

const DtIfFrameRateResponse& DtIfFrameRateResponse::operator=

(

const DtIfFrameRateResponse &

orig

)

assignment operator

virtual int DtIfFrameRateResponse::type ( ) const

overridevirtual

Returns the type of Interface Content; DtIfFrameRateResponse.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfFrameRateResponse::clone ( ) const

overridevirtual

Implements DtSimInterfaceContent.

virtual int DtIfFrameRateResponse::numSections ( ) const

virtual

Number of sections in this message.

virtual int DtIfFrameRateResponse::section ( int  ) const

virtual

Returns the section number at the given index. Use this section number to get the actual data.

const DtBackend::SectionTimes& DtIfFrameRateResponse::sectionTimes ( ) const

inline

virtual double DtIfFrameRateResponse::frameRateMean ( int  section ) const

virtual

virtual void DtIfFrameRateResponse::setFrameRateMean ( int  section, double  frameRateMean  )

virtual

virtual double DtIfFrameRateResponse::frameRateMedian ( int  section ) const

virtual

virtual void DtIfFrameRateResponse::setFrameRateMedian ( int  section, double  frameRateMedian  )

virtual

virtual double DtIfFrameRateResponse::frameRateStandardDeviation ( int  section ) const

virtual

virtual void DtIfFrameRateResponse::setFrameRateStandardDeviation ( int  section, double  frameRateStandardDeviation  )

virtual

virtual double DtIfFrameRateResponse::minFrameRate ( int  section ) const

virtual

virtual void DtIfFrameRateResponse::setMinFrameRate ( int  section, double  minFrameRate  )

virtual

virtual double DtIfFrameRateResponse::maxFrameRate ( int  section ) const

virtual

virtual void DtIfFrameRateResponse::setMaxFrameRate ( int  section, double  maxFrameRate  )

virtual

virtual double DtIfFrameRateResponse::frameRateResponsePeriod ( )

virtual

virtual void DtIfFrameRateResponse::setFrameRateResponsePeriod ( double  period )

virtual

virtual unsigned int DtIfFrameRateResponse::framesAveraged ( )

virtual

virtual void DtIfFrameRateResponse::setFramesAveraged ( unsigned int  frames )

virtual

virtual double DtIfFrameRateResponse::simTimeToRealTimeRatio ( )

virtual

Ratio of simulation time to real (wall-clock) time. Default is 1.0.

virtual void DtIfFrameRateResponse::setSimTimeToRealTimeRatio ( double  ratio )

virtual

Ratio of simulation time to real (wall-clock) time. Default is 1.0.

virtual void DtIfFrameRateResponse::setNumberOfTickThreads ( short  )

virtual

virtual short DtIfFrameRateResponse::numberOfTickThreads ( ) const

virtual

virtual void DtIfFrameRateResponse::setNumberOfCPUs ( short  )

virtual

virtual short DtIfFrameRateResponse::numberOfCPUs ( ) const

virtual

virtual void DtIfFrameRateResponse::setTickingPublishersDuringObjectTick ( bool  )

virtual

virtual bool DtIfFrameRateResponse::tickingPublishersDuringObjectTick ( ) const

virtual

virtual int DtIfFrameRateResponse::netRepSize ( ) const

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFrameRateResponse::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFrameRateResponse::setToNet ( )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfFrameRateResponse::printDataToString ( DtString &  str )

overridevirtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfFrameRateResponse::creator ( )

static

Member Data Documentation

DtBackend::SectionTimes DtIfFrameRateResponse::mySectionTimes

protected

DtFloat64 DtIfFrameRateResponse::myFrameRateResponsePeriod

protected

DtU32 DtIfFrameRateResponse::myFramesAveraged

protected

DtFloat64 DtIfFrameRateResponse::mySimTimeToRealTimeRatio

protected

DtU16 DtIfFrameRateResponse::myNumberOfTickThreads

protected

DtU16 DtIfFrameRateResponse::myNumberOfCPUs

protected

bool DtIfFrameRateResponse::myTickingPublishersDuringObjectTick

protected

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmsgs/ifFrameRateResponse.h