DtIfStatus Class Reference

Instances of DtIfStatus are sent out in response to a DtIfStatusRequest message and have boolean values to indicate if the application is capable of simulating entities and if it is in a loaded state. More...

Inheritance diagram for DtIfStatus:

Public Member Functions
	DtIfStatus ()
	default constructor
virtual	~DtIfStatus ()
	destructor
	DtIfStatus (const DtIfStatus &orig)
	copy constructor
DtIfStatus &	operator= (const DtIfStatus &orig)
	assignment operator
virtual int	type () const
	Returns the type of Interface Content; DtStatusMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual DtTime	exerciseStartTime () const
	exercise start simulation time in seconds (defaults to 0.0).
virtual void	setExerciseStartTime (DtTime time)
virtual DtTime	simTime () const
	simulation time (simulation time elapsed since start of simulation) in seconds (defaults to 0.0).
virtual void	setSimTime (DtTime time)
virtual DtTime	simStartSimTime () const
	simulation start simulation time.
virtual void	setSimStartSimTime (DtTime time)
virtual double	timeMultiplier () const
	Set faster or slower than real-time operation (defaults to 1.0).
virtual void	setTimeMultiplier (double timeMultiplier)
virtual int	controlState () const
	Current control state of backend Valid values are either DtRunControlType or DtPauseControlType.
virtual void	setControlState (int state)
virtual DtInetAddr	ipAddress () const
virtual void	setIpAddress (DtInetAddr ipAddr)
virtual unsigned int	port () const
virtual void	setPort (unsigned int port)
virtual bool	isFinalStatusMsg () const
virtual void	setIsFinalStatusMsg (bool finalMsg)
virtual bool	isCurrentParameterDb () const
virtual void	setIsCurrentParameterDb (bool isCurrentParameterDb)
virtual bool	isResourceMonitorEnabled () const
virtual void	setIsResourceMonitorEnabled (bool isCurrentParameterDb)
virtual bool	isLoaded () const
	If this flag is true, this backend has been loaded with a scenario.
virtual void	setIsLoaded (const bool loaded)
virtual void	setIsTimeManaged (bool yesNo)
virtual bool	isTimeManaged () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual bool	canSimulate () const
	Returns true if the simulation is loaded and the user can simulate on this back-end.
virtual void	setCanSimulate (const bool frontEnd)
virtual DtString	scenarioName () const
	The name of the scenario that is currently loaded, if any.
virtual void	setScenarioName (const DtString &name)
	The name of the scenario that is currently loaded, if any.
virtual DtString	terrainName () const
	The name of the terrain file that is currently loaded or in use by the sim engine.
virtual void	setTerrainName (const DtString &name)
	The name of the terrain file that is currently loaded or in use by the sim engine.
virtual DtString	guiTerrainName () const
	The name of the terrain file loaded by the GUI.
virtual void	setGuiTerrainName (const DtString &name)
	The name of the terrain file loaded by the GUI.
virtual unsigned int	simEngineId () const
	The ID of the sim engine.
virtual void	setSimEngineId (unsigned int id)
	The ID of the sim engine.
virtual void	setLoadedNewScenario (bool)
	Set to true if a new scenario has just been loaded.
virtual bool	loadedNewScenario () const
	Set to true if a new scenario has just been loaded.

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtU32	myPort
DtU16	myControlState
DtInetAddr	myInetAddr
bool	myIsFinalStatusMsg
bool	myIsCurrentParameterDb
bool	myResourceMonitorIsEnabled
bool	myIsLoaded
DtTime	myExerciseStartTime
DtTime	mySimTime
DtTime	mySimStartSimTime
double	myTimeMultiplier
bool	myIsTimeManaged
bool	myLoadedNewScenario
DtString	myScenarioName
DtString	myTerrainName
DtString	myGuiTerrainName
DtU32	mySimEngineId
bool	myCanSimulate
	For backwards compatibility!

Detailed Description

Instances of DtIfStatus are sent out in response to a DtIfStatusRequest message and have boolean values to indicate if the application is capable of simulating entities and if it is in a loaded state.

Also contains general status information about the simulation engine.

Content-Type: DtStatusMessageType

Constructor & Destructor Documentation

DtIfStatus::DtIfStatus

(

)

default constructor

virtual DtIfStatus::~DtIfStatus ( )

virtual

destructor

DtIfStatus::DtIfStatus

(

const DtIfStatus &

orig

)

copy constructor

Member Function Documentation

DtIfStatus& DtIfStatus::operator=

(

const DtIfStatus &

orig

)

assignment operator

virtual int DtIfStatus::type ( ) const

virtual

Returns the type of Interface Content; DtStatusMessageType.

virtual DtSimInterfaceContent* DtIfStatus::clone ( ) const

virtual

virtual DtTime DtIfStatus::exerciseStartTime ( ) const

virtual

exercise start simulation time in seconds (defaults to 0.0).

virtual void DtIfStatus::setExerciseStartTime ( DtTime  time )

virtual

virtual DtTime DtIfStatus::simTime ( ) const

virtual

simulation time (simulation time elapsed since start of simulation) in seconds (defaults to 0.0).

virtual void DtIfStatus::setSimTime ( DtTime  time )

virtual

virtual DtTime DtIfStatus::simStartSimTime ( ) const

virtual

simulation start simulation time.

virtual void DtIfStatus::setSimStartSimTime ( DtTime  time )

virtual

virtual double DtIfStatus::timeMultiplier ( ) const

virtual

Set faster or slower than real-time operation (defaults to 1.0).

virtual void DtIfStatus::setTimeMultiplier ( double  timeMultiplier )

virtual

virtual int DtIfStatus::controlState ( ) const

virtual

Current control state of backend Valid values are either DtRunControlType or DtPauseControlType.

virtual void DtIfStatus::setControlState ( int  state )

virtual

virtual DtInetAddr DtIfStatus::ipAddress ( ) const

virtual

virtual void DtIfStatus::setIpAddress ( DtInetAddr  ipAddr )

virtual

virtual unsigned int DtIfStatus::port ( ) const

virtual

virtual void DtIfStatus::setPort ( unsigned int  port )

virtual

virtual bool DtIfStatus::isFinalStatusMsg ( ) const

virtual

virtual void DtIfStatus::setIsFinalStatusMsg ( bool  finalMsg )

virtual

virtual bool DtIfStatus::isCurrentParameterDb ( ) const

virtual

virtual void DtIfStatus::setIsCurrentParameterDb ( bool  isCurrentParameterDb )

virtual

virtual bool DtIfStatus::isResourceMonitorEnabled ( ) const

virtual

virtual void DtIfStatus::setIsResourceMonitorEnabled ( bool  isCurrentParameterDb )

virtual

virtual bool DtIfStatus::isLoaded ( ) const

virtual

If this flag is true, this backend has been loaded with a scenario.

Note that a scenario can be loaded, however, it might not be able to be simulated on

virtual void DtIfStatus::setIsLoaded ( const bool  loaded )

virtual

virtual void DtIfStatus::setIsTimeManaged ( bool  yesNo )

virtual

virtual bool DtIfStatus::isTimeManaged ( ) const

virtual

virtual DtString DtIfStatus::scenarioName ( ) const

virtual

The name of the scenario that is currently loaded, if any.

If no scenario is loaded by the sim engine, this sill be a null string.

virtual void DtIfStatus::setScenarioName ( const DtString &  name )

virtual

The name of the scenario that is currently loaded, if any.

If no scenario is loaded by the sim engine, this sill be a null string.

virtual DtString DtIfStatus::terrainName ( ) const

virtual

The name of the terrain file that is currently loaded or in use by the sim engine.

If none, this will be a null string.

virtual void DtIfStatus::setTerrainName ( const DtString &  name )

virtual

The name of the terrain file that is currently loaded or in use by the sim engine.

If none, this will be a null string.

virtual DtString DtIfStatus::guiTerrainName ( ) const

virtual

The name of the terrain file loaded by the GUI.

If null, then the GUI is loading terrainName().

virtual void DtIfStatus::setGuiTerrainName ( const DtString &  name )

virtual

The name of the terrain file loaded by the GUI.

If null, then the GUI is loading terrainName().

virtual unsigned int DtIfStatus::simEngineId ( ) const

virtual

The ID of the sim engine.

This is a simple ID that differentiates on sim engine from another.

virtual void DtIfStatus::setSimEngineId ( unsigned int  id )

virtual

The ID of the sim engine.

This is a simple ID that differentiates on sim engine from another.

virtual void DtIfStatus::setLoadedNewScenario ( bool  )

virtual

Set to true if a new scenario has just been loaded.

virtual bool DtIfStatus::loadedNewScenario ( ) const

virtual

Set to true if a new scenario has just been loaded.

virtual int DtIfStatus::netRepSize ( ) const

virtual

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

virtual

virtual bool DtIfStatus::setToNet ( )

virtual

virtual void DtIfStatus::printDataToString ( DtString &  str )

virtual

static DtSimInterfaceContent* DtIfStatus::creator ( )

static

virtual bool DtIfStatus::canSimulate ( ) const

virtual

Returns true if the simulation is loaded and the user can simulate on this back-end.

Reused boolean from older scenarios

virtual void DtIfStatus::setCanSimulate ( const bool  frontEnd )

virtual

Member Data Documentation

DtU32 DtIfStatus::myPort

protected

DtU16 DtIfStatus::myControlState

protected

DtInetAddr DtIfStatus::myInetAddr

protected

bool DtIfStatus::myIsFinalStatusMsg

protected

bool DtIfStatus::myIsCurrentParameterDb

protected

bool DtIfStatus::myResourceMonitorIsEnabled

protected

bool DtIfStatus::myIsLoaded

protected

DtTime DtIfStatus::myExerciseStartTime

protected

DtTime DtIfStatus::mySimTime

protected

DtTime DtIfStatus::mySimStartSimTime

protected

double DtIfStatus::myTimeMultiplier

protected

bool DtIfStatus::myIsTimeManaged

protected

bool DtIfStatus::myLoadedNewScenario

protected

DtString DtIfStatus::myScenarioName

protected

DtString DtIfStatus::myTerrainName

protected

DtString DtIfStatus::myGuiTerrainName

protected

DtU32 DtIfStatus::mySimEngineId

protected

bool DtIfStatus::myCanSimulate

protected

For backwards compatibility!

---

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

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