VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
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.

Protected Attributes

DtString myTerrainName
DtString myGuiTerrainName
DtString myScenarioName
int myNumberOfSimEngines

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.

Member Data Documentation

DtString DtSessionStatus::myTerrainName
protected
DtString DtSessionStatus::myGuiTerrainName
protected
DtString DtSessionStatus::myScenarioName
protected
int DtSessionStatus::myNumberOfSimEngines
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)