DtIfStatus Class Reference

Inheritance diagram for DtIfStatus:

Public Types
typedef std::map< DtU16, int >	ObjectCounts

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 void	setRunDurationTime (double)
	The simulation time at which the back-end will pause the simulation.
virtual double	runDurationTime () const
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 int	scenarioRunId () const
	If used, the unique scenario run id.
virtual void	setScenarioRunId (int)
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 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)
bool	oldStyleStatus () const
virtual void	setIsTimeManaged (bool yesNo)
virtual bool	isTimeManaged () const
virtual void	addLocalObject (int kind, int domain)
virtual void	removeLocalObject (int kind, int domain)
virtual int	totalLocalObjects () const
const ObjectCounts &	objectCounts () const
virtual unsigned int	simEngineId () const
	The ID of the sim engine.
virtual void	setSimEngineId (unsigned int id)
virtual void	setLoadingScenario (bool)
	Set to true if in the process of loading a scenario.
virtual bool	loadingScenario () const
virtual void	setImportingScenario (bool)
	Set to true if in the process of importing a scenario.
virtual bool	importingScenario () const
virtual void	setHostingDynamicTerrainServer (bool)
	Set to true if this back-end is hosting a dynamic terrain server.
virtual bool	hostingDynamicTerrainServer () const
virtual void	setCreatingSimulationObjectGroup (bool)
	Set to true if in the process of creating a simulation object group.
virtual bool	creatingSimulationObjectGroup () const
virtual void	setClosingScenario (bool)
	Set to true if in the process of closing a scenario.
virtual bool	closingScenario () const
virtual void	setRollingBackScenario (bool)
	Set to true if in the process of rolling back a scenario.
virtual bool	rollingBackScenario () const
virtual void	setLoadedNewScenario (bool)
	Set to true if a new scenario has just been loaded.
virtual bool	loadedNewScenario () const
virtual DtU32	scenarioCapabilities () const
	Indicates the capabilities of the VRF Sim based application sending this status message.
virtual void	setScenarioCapabilities (DtU32 v)
virtual void	setScenarioCapability (DtU32 v, bool b)
virtual DtString	applicationType () const
	A human readable string indicating the type of application that is sending the status message, such as "VR-Forces Sim Engine" or "VR-Engage Sim Engine".
virtual void	setApplicationType (const DtString &type)
const DtString &	scenarioName () const
	Deprecated – used for backwards compatibility.
const DtString &	terrainName () const
const DtString &	guiTerrainName () 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
DtU32	myVersion
	New versions of status message have a version.
DtU32	myPort
DtU16	myControlState
DtInetAddr	myInetAddr
bool	myIsFinalStatusMsg
bool	myIsCurrentParameterDb
bool	myResourceMonitorIsEnabled
bool	myIsLoaded
DtTime	myExerciseStartTime
DtTime	mySimTime
DtTime	mySimStartSimTime
double	myTimeMultiplier
bool	myLoadedNewScenario
DtU32	mySimEngineId
bool	myCanSimulate
bool	myIsTimeManaged
bool	myLoadingScenario
bool	myImportingScenario
bool	myHostingDynamicTerrainServer
bool	myCreatingSimulationObjectGroup
bool	myClosingScenario
bool	myRollingBackScenario
DtU32	myScenarioRunId
DtU32	myScenarioCapabilities
	Bitfield indicating at what level this sim engine participates with the scenario.
DtString	myApplicationType
	String indicating what application this sim engine is, for example "VR-Forces Sim" or "VR-Engage Sim".
ObjectCounts	myObjectCounts
	This map contains the count of kind/domain of objects available.
DtTime	myRunDurationTime
DtString	myScenarioName
	Deprecated – used for backwards compatability. Now part of DtIfScenarioStatus message.
DtString	myTerrainName
DtString	myGuiTerrainName
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

Member Typedef Documentation

typedef std::map<DtU16, int> DtIfStatus::ObjectCounts

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.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfStatus::clone ( ) const

virtual

Implements DtSimInterfaceContent.

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 void DtIfStatus::setRunDurationTime ( double  )

virtual

The simulation time at which the back-end will pause the simulation.

If 0 will run until the user presses the pause button

virtual double DtIfStatus::runDurationTime ( ) const

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 void DtIfStatus::addLocalObject ( int  kind, int  domain  )

virtual

Deals with locally published objects. Keys are stored as high char of kind and low char of domain with the count of each

virtual void DtIfStatus::removeLocalObject ( int  kind, int  domain  )

virtual

virtual int DtIfStatus::totalLocalObjects ( ) const

virtual

const ObjectCounts& DtIfStatus::objectCounts ( ) const

inline

virtual int DtIfStatus::scenarioRunId ( ) const

virtual

If used, the unique scenario run id.

virtual void DtIfStatus::setScenarioRunId ( int  )

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 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

virtual void DtIfStatus::setLoadingScenario ( bool  )

virtual

Set to true if in the process of loading a scenario.

virtual bool DtIfStatus::loadingScenario ( ) const

virtual

virtual void DtIfStatus::setImportingScenario ( bool  )

virtual

Set to true if in the process of importing a scenario.

virtual bool DtIfStatus::importingScenario ( ) const

virtual

virtual void DtIfStatus::setHostingDynamicTerrainServer ( bool  )

virtual

Set to true if this back-end is hosting a dynamic terrain server.

virtual bool DtIfStatus::hostingDynamicTerrainServer ( ) const

virtual

virtual void DtIfStatus::setCreatingSimulationObjectGroup ( bool  )

virtual

Set to true if in the process of creating a simulation object group.

virtual bool DtIfStatus::creatingSimulationObjectGroup ( ) const

virtual

virtual void DtIfStatus::setClosingScenario ( bool  )

virtual

Set to true if in the process of closing a scenario.

virtual bool DtIfStatus::closingScenario ( ) const

virtual

virtual void DtIfStatus::setRollingBackScenario ( bool  )

virtual

Set to true if in the process of rolling back a scenario.

virtual bool DtIfStatus::rollingBackScenario ( ) const

virtual

virtual void DtIfStatus::setLoadedNewScenario ( bool  )

virtual

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

virtual bool DtIfStatus::loadedNewScenario ( ) const

virtual

virtual int DtIfStatus::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfStatus::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfStatus::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

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

bool DtIfStatus::oldStyleStatus ( ) const

inline

virtual void DtIfStatus::setIsTimeManaged ( bool  yesNo )

virtual

virtual bool DtIfStatus::isTimeManaged ( ) const

virtual

virtual DtU32 DtIfStatus::scenarioCapabilities ( ) const

virtual

Indicates the capabilities of the VRF Sim based application sending this status message.

See Also

DtScenarioCapabilities

virtual void DtIfStatus::setScenarioCapabilities ( DtU32  v )

virtual

virtual void DtIfStatus::setScenarioCapability ( DtU32  v, bool  b  )

virtual

virtual DtString DtIfStatus::applicationType ( ) const

virtual

A human readable string indicating the type of application that is sending the status message, such as "VR-Forces Sim Engine" or "VR-Engage Sim Engine".

virtual void DtIfStatus::setApplicationType ( const DtString &  type )

virtual

const DtString& DtIfStatus::scenarioName ( ) const

inline

Deprecated – used for backwards compatibility.

Now part of DtIfScenarioStatus message

const DtString& DtIfStatus::terrainName ( ) const

inline

const DtString& DtIfStatus::guiTerrainName ( ) const

inline

Member Data Documentation

DtU32 DtIfStatus::myVersion

protected

New versions of status message have a version.

The high word is a signal that the version exists, and the low word is the actual version. If this information does not exist it is assumed to be an older status message

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::myLoadedNewScenario

protected

DtU32 DtIfStatus::mySimEngineId

protected

bool DtIfStatus::myCanSimulate

protected

bool DtIfStatus::myIsTimeManaged

protected

bool DtIfStatus::myLoadingScenario

protected

bool DtIfStatus::myImportingScenario

protected

bool DtIfStatus::myHostingDynamicTerrainServer

protected

bool DtIfStatus::myCreatingSimulationObjectGroup

protected

bool DtIfStatus::myClosingScenario

protected

bool DtIfStatus::myRollingBackScenario

protected

DtU32 DtIfStatus::myScenarioRunId

protected

DtU32 DtIfStatus::myScenarioCapabilities

protected

Bitfield indicating at what level this sim engine participates with the scenario.

DtString DtIfStatus::myApplicationType

protected

String indicating what application this sim engine is, for example "VR-Forces Sim" or "VR-Engage Sim".

ObjectCounts DtIfStatus::myObjectCounts

protected

This map contains the count of kind/domain of objects available.

The key is two chars high char is kind and low char is domain. The value is the count of those items

DtTime DtIfStatus::myRunDurationTime

protected

DtString DtIfStatus::myScenarioName

protected

Deprecated – used for backwards compatability. Now part of DtIfScenarioStatus message.

DtString DtIfStatus::myTerrainName

protected

DtString DtIfStatus::myGuiTerrainName

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfmsgs/ifStatus.h