DtIfFrameRateRequest Class Reference

DtIfFrameRateRequest is the content portion of a frame rate request message. It is sent to request a single or periodic update of frame rate, or to change the parameters of frame rate monitoring.

Content-Type: DtFrameRateRequestMessageType

Inheritance diagram for DtIfFrameRateRequest:

Public Member Functions
	DtIfFrameRateRequest ()
	DtIfFrameRateRequest (const DtIfFrameRateRequest &orig)
const DtIfFrameRateRequest &	operator= (const DtIfFrameRateRequest &orig)
virtual	~DtIfFrameRateRequest ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual double	frameRateResponsePeriod () const
virtual void	setFrameRateResponsePeriod (double responsePeriod)
virtual unsigned int	populationSize () const
virtual void	setPopulationSize (unsigned int populationSize)
virtual bool	computeMean () const
virtual void	setComputeMean (bool computeMean)
virtual bool	computeMedian () const
virtual void	setComputeMedian (bool computeMedian)
virtual bool	computeStandardDeviation () const
virtual void	setComputeStandardDeviation (bool computeStandardDeviation)
virtual bool	computeMinFrameTime () const
virtual void	setComputeMinFrameTime (bool minFrameTime)
virtual bool	computeMaxFrameTime () const
virtual void	setComputeMaxFrameTime (bool maxFrameTime)
virtual bool	requestConsoleOutput () const
virtual void	setRequestConsoleOutput (bool requestConsoleOutput)
virtual bool	computeSimTimeToRealTimeRatio () const
virtual void	setComputeSimTimeToRealTimeRatio (bool computeSimTimToRealTimeRatio)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
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
double	myFrameRateResponsePeriod
unsigned int	myPopulationSize
bool	myComputeMean
bool	myComputeMedian
bool	myComputeStandardDeviation
bool	myComputeMaxFrameTime
bool	myComputeMinFrameTime
bool	myRequestConsoleOutput
bool	myComputeSimTimeToRealTimeRatio
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

DtIfFrameRateRequest::DtIfFrameRateRequest

(

)

default constructor

DtIfFrameRateRequest::DtIfFrameRateRequest

(

const DtIfFrameRateRequest &

orig

)

copy constructor

virtual DtIfFrameRateRequest::~DtIfFrameRateRequest ( )

virtual

Member Function Documentation

const DtIfFrameRateRequest& DtIfFrameRateRequest::operator=

(

const DtIfFrameRateRequest &

orig

)

assignment operator

virtual int DtIfFrameRateRequest::type ( ) const

virtual

Returns the type of Interface Content; DtIfFrameRateRequest.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfFrameRateRequest::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual double DtIfFrameRateRequest::frameRateResponsePeriod ( ) const

virtual

virtual void DtIfFrameRateRequest::setFrameRateResponsePeriod ( double  responsePeriod )

virtual

virtual unsigned int DtIfFrameRateRequest::populationSize ( ) const

virtual

virtual void DtIfFrameRateRequest::setPopulationSize ( unsigned int  populationSize )

virtual

virtual bool DtIfFrameRateRequest::computeMean ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeMean ( bool  computeMean )

virtual

virtual bool DtIfFrameRateRequest::computeMedian ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeMedian ( bool  computeMedian )

virtual

virtual bool DtIfFrameRateRequest::computeStandardDeviation ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeStandardDeviation ( bool  computeStandardDeviation )

virtual

virtual bool DtIfFrameRateRequest::computeMinFrameTime ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeMinFrameTime ( bool  minFrameTime )

virtual

virtual bool DtIfFrameRateRequest::computeMaxFrameTime ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeMaxFrameTime ( bool  maxFrameTime )

virtual

virtual bool DtIfFrameRateRequest::requestConsoleOutput ( ) const

virtual

virtual void DtIfFrameRateRequest::setRequestConsoleOutput ( bool  requestConsoleOutput )

virtual

virtual bool DtIfFrameRateRequest::computeSimTimeToRealTimeRatio ( ) const

virtual

virtual void DtIfFrameRateRequest::setComputeSimTimeToRealTimeRatio ( bool  computeSimTimToRealTimeRatio )

virtual

virtual int DtIfFrameRateRequest::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFrameRateRequest::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfFrameRateRequest::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfFrameRateRequest::creator ( )

static

Member Data Documentation

double DtIfFrameRateRequest::myFrameRateResponsePeriod

protected

If 0.0, only a single response is generated.

unsigned int DtIfFrameRateRequest::myPopulationSize

protected

Frame rate will be averaged over this many previous frames.

bool DtIfFrameRateRequest::myComputeMean

protected

true by default.

bool DtIfFrameRateRequest::myComputeMedian

protected

false by default.

bool DtIfFrameRateRequest::myComputeStandardDeviation

protected

false by default.

bool DtIfFrameRateRequest::myComputeMaxFrameTime

protected

false by default.

bool DtIfFrameRateRequest::myComputeMinFrameTime

protected

false by default.

bool DtIfFrameRateRequest::myRequestConsoleOutput

protected

false by default.

bool DtIfFrameRateRequest::myComputeSimTimeToRealTimeRatio

protected

false by default

---

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

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