DtSessionStatus Class Reference

Basic container class that holds the status of a session of VRF sim engines.

Public Member Functions
	DtSessionStatus ()
	DtSessionStatus (const DtSessionStatus &orig)
DtSessionStatus &	operator= (const DtSessionStatus &orig)
virtual	~DtSessionStatus ()
virtual void	setExerciseStartTime (double)
virtual double	exerciseStartTime () const
virtual void	setFrameRateMode (char)
virtual char	frameRateMode () const
virtual void	setGuiRuntimeLoadBalancingScheme (const DtString &scheme, const DtString &userData)
virtual void	getGuiRuntimeLoadBalancingScheme (DtString &scheme, DtString &userData) const
virtual const DtFilename &	terrainName () const
virtual void	setTerrainName (const DtFilename &name)
virtual const DtFilename &	guiTerrainName () const
virtual void	setGuiTerrainName (const DtFilename &name)
virtual const DtString &	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual const DtFilename &	scenarioFilename () const
virtual void	setScenarioFilename (const DtFilename &name)
virtual int	numberOfSimEngines () const
virtual void	setNumberOfSimEngines (int n)
virtual void	setSimulationModelSets (const std::vector< DtFilename > &)
virtual void	setSimulationModelSets (const DtRwNLengthStringVector &)
virtual const std::vector < DtFilename > &	simulationModelSets () const
virtual DtRwKeyValueList &	scenarioData ()
virtual const DtRwKeyValueList &	scenarioData () const

Protected Attributes
DtFilename	myTerrainName
DtFilename	myGuiTerrainName
DtString	myScenarioName
DtFilename	myScenarioFilename
int	myNumberOfSimEngines
std::vector< DtFilename >	mySimulationModelSets
DtRwKeyValueList	myScenarioData
double	myExerciseStartTime
char	myFrameRateMode
DtString	myGuiRuntimeLoadBalancingScheme
DtString	myGuiRuntimeLoadBalancingSchemeData

Constructor & Destructor Documentation

DtSessionStatus::DtSessionStatus

(

)

DtSessionStatus::DtSessionStatus

(

const DtSessionStatus &

orig

)

virtual DtSessionStatus::~DtSessionStatus ( )

virtual

Member Function Documentation

DtSessionStatus& DtSessionStatus::operator=

(

const DtSessionStatus &

orig

)

virtual void DtSessionStatus::setFrameRateMode ( char  )

virtual

The frame rate mode of the scenario.

virtual char DtSessionStatus::frameRateMode ( ) const

virtual

The frame rate mode of the scenario.

virtual void DtSessionStatus::setGuiRuntimeLoadBalancingScheme ( const DtString &  scheme, const DtString &  userData  )

virtual

The runtime load balancing scheme is what is used by the front-end to balance entities being created. Since every front-end must use this scheme is it part of the scenario and transmitted over the network as part of the status message. When the scheme is received the remote controller will get the scheme from the load balancing factory and set it as the scheme for creating of new objects.

virtual void DtSessionStatus::getGuiRuntimeLoadBalancingScheme ( DtString &  scheme, DtString &  userData  ) const

virtual

The runtime load balancing scheme is what is used by the front-end to balance entities being created. Since every front-end must use this scheme is it part of the scenario and transmitted over the network as part of the status message. When the scheme is received the remote controller will get the scheme from the load balancing factory and set it as the scheme for creating of new objects.

virtual const DtFilename& DtSessionStatus::terrainName ( ) const

virtual

The terrain that is currently loaded by the sim engines in the session.

virtual void DtSessionStatus::setTerrainName ( const DtFilename &  name )

virtual

The terrain that is currently loaded by the sim engines in the session.

virtual const DtFilename& DtSessionStatus::guiTerrainName ( ) const

virtual

The terrain that the GUI should load (according to the loaded scenario) in the session.

virtual void DtSessionStatus::setGuiTerrainName ( const DtFilename &  name )

virtual

The terrain that the GUI should load (according to the loaded scenario) in the session.

virtual const DtString& DtSessionStatus::scenarioName ( ) const

virtual

The scenario name that is currently loaded by the sim engines in the session.

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

virtual

The scenario name that is currently loaded by the sim engines in the session.

virtual const DtFilename& DtSessionStatus::scenarioFilename ( ) const

virtual

The scenario filename name that is currently loaded by the sim engines in the session. This is different than scenario name where scenario name is a short description of the scenario. This is the filename loaded.

virtual void DtSessionStatus::setScenarioFilename ( const DtFilename &  name )

virtual

The scenario filename name that is currently loaded by the sim engines in the session. This is different than scenario name where scenario name is a short description of the scenario. This is the filename loaded.

virtual int DtSessionStatus::numberOfSimEngines ( ) const

virtual

The number of simulation engines that are currently part of the session.

virtual void DtSessionStatus::setNumberOfSimEngines ( int  n )

virtual

The number of simulation engines that are currently part of the session.

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

virtual

Simulation model sets in use.

virtual void DtSessionStatus::setSimulationModelSets ( const DtRwNLengthStringVector &  )

virtual

Simulation model sets in use.

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

virtual

Simulation model sets in use.

virtual DtRwKeyValueList& DtSessionStatus::scenarioData ( )

virtual

Access the scenario data key value list. Note that these values are returned as strings so if you're getting something which is a file path (for instance "GuiObserverViews") make sure to use it to initialize a DtFilename and then take the value from that to make sure the slashes in the file path are properly converted.

virtual const DtRwKeyValueList& DtSessionStatus::scenarioData ( ) const

virtual

Access the scenario data key value list. Note that these values are returned as strings so if you're getting something which is a file path (for instance "GuiObserverViews") make sure to use it to initialize a DtFilename and then take the value from that to make sure the slashes in the file path are properly converted.

virtual void DtSessionStatus::setExerciseStartTime ( double  )

virtual

virtual double DtSessionStatus::exerciseStartTime ( ) const

virtual

Member Data Documentation

DtFilename DtSessionStatus::myTerrainName

protected

DtFilename DtSessionStatus::myGuiTerrainName

protected

DtString DtSessionStatus::myScenarioName

protected

DtFilename DtSessionStatus::myScenarioFilename

protected

int DtSessionStatus::myNumberOfSimEngines

protected

std::vector<DtFilename> DtSessionStatus::mySimulationModelSets

protected

DtRwKeyValueList DtSessionStatus::myScenarioData

protected

double DtSessionStatus::myExerciseStartTime

protected

char DtSessionStatus::myFrameRateMode

protected

DtString DtSessionStatus::myGuiRuntimeLoadBalancingScheme

protected

DtString DtSessionStatus::myGuiRuntimeLoadBalancingSchemeData

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/sessionStatus.h