DtIfControl Class Reference

File: ifControl.h.

Class: DtIfControl DtIfControl is the content portion of a control message. It's typically only sent from front-end to back. It includes simple control statements like run and pause.

Content-Type: DtControlMessageType

Parameters: controlType - An integer that is the type of control command, such as "pause" (DtPauseControlType) or "run" (DtRunControlType). These integers are defined in msgTypes.h.

Inheritance diagram for DtIfControl:

Public Member Functions
	DtIfControl ()
	DtIfControl (const DtIfControl &orig)
const DtIfControl &	operator= (const DtIfControl &orig)
virtual	~DtIfControl ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual int	controlType () const
virtual void	setControlType (int controlType)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual double	duration () const
virtual void	setDuration (double time)
virtual void	setScenarioRunId (int)
virtual int	scenarioRunId () const
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
int	myControlType
double	myTime
int	myScenarioRunId
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

DtIfControl::DtIfControl

(

)

default constructor

DtIfControl::DtIfControl

(

const DtIfControl &

orig

)

copy constructor

virtual DtIfControl::~DtIfControl ( )

virtual

Member Function Documentation

const DtIfControl& DtIfControl::operator=

(

const DtIfControl &

orig

)

assignment operator

virtual int DtIfControl::type ( ) const

virtual

Returns the type of Interface Content; DtControlMessageName.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfControl::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfControl::controlType ( ) const

virtual

Type of control, such as pause or run. Use XxxControlType strings in msgTypes.h.

virtual void DtIfControl::setControlType ( int  controlType )

virtual

virtual int DtIfControl::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfControl::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfControl::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfControl::creator ( )

static

virtual double DtIfControl::duration ( ) const

virtual

These have been added for backwards compatibility with DtIfRunDurationControl and may be removed or altered.

virtual void DtIfControl::setDuration ( double  time )

virtual

virtual void DtIfControl::setScenarioRunId ( int  )

virtual

An ID that is used to now uniquely identify messages sent with this scenario rollback. Used to try and prevent messages from a previous scenario interfering with the new. In each new construct of this message, the scenario run id is set to a random number. Only relevant for scenario rewind.

virtual int DtIfControl::scenarioRunId ( ) const

virtual

Member Data Documentation

int DtIfControl::myControlType

protected

double DtIfControl::myTime

protected

int DtIfControl::myScenarioRunId

protected

---

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

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