DtIfScenarioStatus Class Reference

Inheritance diagram for DtIfScenarioStatus:

Public Member Functions
	DtIfScenarioStatus ()
	default constructor
virtual	~DtIfScenarioStatus ()
	destructor
	DtIfScenarioStatus (const DtIfScenarioStatus &orig)
	copy constructor
DtIfScenarioStatus &	operator= (const DtIfScenarioStatus &orig)
	assignment operator
virtual int	type () const
	Returns the type of Interface Content; DtStatusMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
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 void	setSimulationModelSets (const std::vector< DtFilename > &)
	The simulation model set(s) that are current loaded as part of this scenario.
virtual const std::vector < DtFilename > &	simulationModelSets () const
	The simulation model set(s) that are current loaded as part of this scenario.
virtual void	clearSimulationModelSets ()
	The simulation model set(s) that are current loaded as part of this scenario.

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtU32	myVersion
bool	myIsTimeManaged
DtString	myScenarioName
DtString	myTerrainName
DtString	myGuiTerrainName
std::vector< DtFilename >	mySimulationModelSets

Constructor & Destructor Documentation

DtIfScenarioStatus::DtIfScenarioStatus

(

)

default constructor

virtual DtIfScenarioStatus::~DtIfScenarioStatus ( )

virtual

destructor

DtIfScenarioStatus::DtIfScenarioStatus

(

const DtIfScenarioStatus &

orig

)

copy constructor

Member Function Documentation

DtIfScenarioStatus& DtIfScenarioStatus::operator=

(

const DtIfScenarioStatus &

orig

)

assignment operator

virtual int DtIfScenarioStatus::type ( ) const

virtual

Returns the type of Interface Content; DtStatusMessageType.

virtual DtSimInterfaceContent* DtIfScenarioStatus::clone ( ) const

virtual

virtual DtString DtIfScenarioStatus::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 DtIfScenarioStatus::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 DtIfScenarioStatus::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 DtIfScenarioStatus::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 DtIfScenarioStatus::guiTerrainName ( ) const

virtual

The name of the terrain file loaded by the GUI.

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

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

virtual

The name of the terrain file loaded by the GUI.

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

virtual void DtIfScenarioStatus::setSimulationModelSets ( const std::vector< DtFilename > &  )

virtual

The simulation model set(s) that are current loaded as part of this scenario.

virtual const std::vector<DtFilename>& DtIfScenarioStatus::simulationModelSets ( ) const

virtual

The simulation model set(s) that are current loaded as part of this scenario.

virtual void DtIfScenarioStatus::clearSimulationModelSets ( )

virtual

The simulation model set(s) that are current loaded as part of this scenario.

virtual int DtIfScenarioStatus::netRepSize ( ) const

virtual

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

virtual

virtual bool DtIfScenarioStatus::setToNet ( )

virtual

virtual void DtIfScenarioStatus::printDataToString ( DtString &  str )

virtual

static DtSimInterfaceContent* DtIfScenarioStatus::creator ( )

static

Member Data Documentation

DtU32 DtIfScenarioStatus::myVersion

protected

bool DtIfScenarioStatus::myIsTimeManaged

protected

DtString DtIfScenarioStatus::myScenarioName

protected

DtString DtIfScenarioStatus::myTerrainName

protected

DtString DtIfScenarioStatus::myGuiTerrainName

protected

std::vector<DtFilename> DtIfScenarioStatus::mySimulationModelSets

protected

---

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

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