VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
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)
DtSessionStatusoperator= (const DtSessionStatus &orig)
virtual ~DtSessionStatus ()
virtual DtString terrainName () const
 The terrain that is currently loaded by the sim engines in the session.
virtual void setTerrainName (const DtString &name)
 The terrain that is currently loaded by the sim engines in the session.
virtual DtString guiTerrainName () const
 The terrain that the GUI should load (according to the loaded scenario) in the session.
virtual void setGuiTerrainName (const DtString &name)
 The terrain that the GUI should load (according to the loaded scenario) in the session.
virtual 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 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.
DtString myTerrainName
 Simulation model sets in use.
DtString myGuiTerrainName
 Simulation model sets in use.
DtString myScenarioName
 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 DtString DtSessionStatus::terrainName ( ) const
virtual

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

virtual void DtSessionStatus::setTerrainName ( const DtString name)
virtual

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

virtual DtString DtSessionStatus::guiTerrainName ( ) const
virtual

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

virtual void DtSessionStatus::setGuiTerrainName ( const DtString name)
virtual

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

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

DtString DtSessionStatus::myTerrainName
protected

Simulation model sets in use.

DtString DtSessionStatus::myGuiTerrainName
protected

Simulation model sets in use.

DtString DtSessionStatus::myScenarioName
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:

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)