DtIfFrameRateRequest Class Reference

DtIfFrameRateRequest is the content portion of a frame rate request message. More...

Inheritance diagram for DtIfFrameRateRequest:

Public Member Functions
	DtIfFrameRateRequest ()
	default constructor
	DtIfFrameRateRequest (const DtIfFrameRateRequest &orig)
	copy constructor
const DtIfFrameRateRequest &	operator= (const DtIfFrameRateRequest &orig)
	assignment operator
virtual	~DtIfFrameRateRequest ()
virtual int	type () const
	Returns the type of Interface Content; DtIfFrameRateRequest.
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)

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
double	myFrameRateResponsePeriod
	If 0.0, only a single response is generated.
unsigned int	myPopulationSize
	Frame rate will be averaged over this many previous frames.
bool	myComputeMean
	true by default.
bool	myComputeMedian
	false by default.
bool	myComputeStandardDeviation
	false by default.
bool	myComputeMaxFrameTime
	false by default.
bool	myComputeMinFrameTime
	false by default.
bool	myRequestConsoleOutput
	false by default.
bool	myComputeSimTimeToRealTimeRatio
	false by default

Detailed Description

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

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.

virtual DtSimInterfaceContent* DtIfFrameRateRequest::clone ( ) const

virtual

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

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

virtual

virtual bool DtIfFrameRateRequest::setToNet ( )

virtual

virtual void DtIfFrameRateRequest::printDataToString ( DtString &  str )

virtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifFrameRateRequest.h