DtIfSetFrameMode Class Reference

Total: 9 bytes. More...

Inheritance diagram for DtIfSetFrameMode:

Public Member Functions
	DtIfSetFrameMode ()
	default constructor
	DtIfSetFrameMode (const DtIfSetFrameMode &orig)
	copy constructor
const DtIfSetFrameMode &	operator= (const DtIfSetFrameMode &orig)
	assignment operator
virtual	~DtIfSetFrameMode ()
virtual int	type () const
	Returns the type of Interface Content; DtSetFrameModeMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual int	frameMode () const
	Should be one of the strings for frame mode in msgTypes.h.
virtual void	setFrameMode (int frameMode)
virtual DtReal	frameTime () const
virtual void	setFrameTime (DtReal frameTime)
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	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 ()

Protected Attributes
DtReal	myFrameTime
int	myFrameMode
	Also known as delta-T or dT.
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

Detailed Description

Total: 9 bytes.

DtIfSetFrameMode is the content portion of an exercise clock mode control message. It's typically only sent from front-end to back, based on the "frame-mode" and "frame-time" values stored in a scenario file.

Content-Type: DtSetFrameModeMessageType

Parameters: frameMode - A DtString that is the exercise clock mode. The three standard clock modes are:

• variable-frame (DtVariableFrameModeType)

• fixed-frame (DtFixedFrameModeType)

• fixed-frame-run-to-complete (DtFixedFrameRunToCompleteMode- Type). These strings are defined in msgTypes.h. See VR-Forces User’s Guide for an explanation of the exercise clock modes.

  frameTime - A DtReal value also known as delta-T or dT.

Constructor & Destructor Documentation

DtIfSetFrameMode::DtIfSetFrameMode

(

)

default constructor

DtIfSetFrameMode::DtIfSetFrameMode

(

const DtIfSetFrameMode &

orig

)

copy constructor

virtual DtIfSetFrameMode::~DtIfSetFrameMode ( )

virtual

Member Function Documentation

const DtIfSetFrameMode& DtIfSetFrameMode::operator=

(

const DtIfSetFrameMode &

orig

)

assignment operator

virtual int DtIfSetFrameMode::type ( ) const

virtual

Returns the type of Interface Content; DtSetFrameModeMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSetFrameMode::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfSetFrameMode::frameMode ( ) const

virtual

Should be one of the strings for frame mode in msgTypes.h.

virtual void DtIfSetFrameMode::setFrameMode ( int  frameMode )

virtual

virtual DtReal DtIfSetFrameMode::frameTime ( ) const

virtual

virtual void DtIfSetFrameMode::setFrameTime ( DtReal  frameTime )

virtual

virtual int DtIfSetFrameMode::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSetFrameMode::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSetFrameMode::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfSetFrameMode::creator ( )

static

Member Data Documentation

DtReal DtIfSetFrameMode::myFrameTime

protected

int DtIfSetFrameMode::myFrameMode

protected

Also known as delta-T or dT.

---

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

• include/vrfmsgs/ifFrameMode.h