DtSessionStatus Class Reference

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

Public Member Functions
	DtSessionStatus ()
	DtSessionStatus (const DtSessionStatus &orig)
DtSessionStatus &	operator= (const DtSessionStatus &orig)
virtual	~DtSessionStatus ()
virtual const DtFilename &	terrainName () const
	The terrain that is currently loaded by the sim engines in the session.
virtual void	setTerrainName (const DtFilename &name)
	The terrain that is currently loaded by the sim engines in the session.
virtual const DtFilename &	guiTerrainName () const
	The terrain that the GUI should load (according to the loaded scenario) in the session.
virtual void	setGuiTerrainName (const DtFilename &name)
	The terrain that the GUI should load (according to the loaded scenario) in the session.
virtual const DtString &	scenarioName () const
	The scenario name that is currently loaded by the sim engines in the session.
virtual void	setScenarioName (const DtString &name)
	The scenario name that is currently loaded by the sim engines in the session.
virtual const DtFilename &	scenarioFilename () const
	The scenario filename name that is currently loaded by the sim engines in the session.
virtual void	setScenarioFilename (const DtFilename &name)
	The scenario filename name that is currently loaded by the sim engines in the session.
virtual int	numberOfSimEngines () const
	The number of simulation engines that are currently part of the session.
virtual void	setNumberOfSimEngines (int n)
	The number of simulation engines that are currently part of the session.
DtFilename	myTerrainName
	Simulation model sets in use.
DtFilename	myGuiTerrainName
	Simulation model sets in use.
DtString	myScenarioName
	Simulation model sets in use.
DtFilename	myScenarioFilename
	Simulation model sets in use.
int	myNumberOfSimEngines
	Simulation model sets in use.
std::vector< DtFilename >	mySimulationModelSets
	Simulation model sets in use.
virtual void	setSimulationModelSets (const std::vector< DtFilename > &)
	Simulation model sets in use.
virtual void	setSimulationModelSets (const DtRwNLengthStringVector &)
	Simulation model sets in use.
virtual const std::vector < DtFilename > &	simulationModelSets () const
	Simulation model sets in use.

Detailed Description

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

Constructor & Destructor Documentation

DtSessionStatus::DtSessionStatus

(

)

DtSessionStatus::DtSessionStatus

(

const DtSessionStatus &

orig

)

virtual DtSessionStatus::~DtSessionStatus ( )

virtual

Member Function Documentation

DtSessionStatus& DtSessionStatus::operator=

(

const DtSessionStatus &

orig

)

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.

Member Data Documentation

DtFilename DtSessionStatus::myTerrainName

protected

Simulation model sets in use.

DtFilename DtSessionStatus::myGuiTerrainName

protected

Simulation model sets in use.

DtString DtSessionStatus::myScenarioName

protected

Simulation model sets in use.

DtFilename DtSessionStatus::myScenarioFilename

protected

Simulation model sets in use.

int DtSessionStatus::myNumberOfSimEngines

protected

Simulation model sets in use.

std::vector<DtFilename> DtSessionStatus::mySimulationModelSets

protected

Simulation model sets in use.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfutil/sessionStatus.h