DtIfScenarioStatus Class Reference

Inheritance diagram for DtIfScenarioStatus:

Public Member Functions
	DtIfScenarioStatus ()
virtual	~DtIfScenarioStatus ()
	DtIfScenarioStatus (const DtIfScenarioStatus &orig)
DtIfScenarioStatus &	operator= (const DtIfScenarioStatus &orig)
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual const DtRwKeyValueList &	scenarioData () const
virtual DtRwKeyValueList &	scenarioData ()
virtual void	setScenarioData (const DtRwKeyValueList &data)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual const DtString &	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual const DtFilename &	scenarioFilename () const
virtual void	setScenarioFilename (const DtFilename &name)
virtual const DtFilename &	terrainName () const
virtual void	setTerrainName (const DtFilename &name)
virtual const DtFilename &	guiTerrainName () const
virtual void	setGuiTerrainName (const DtFilename &name)
virtual void	setGuiRuntimeLoadBalancingScheme (const DtString &scheme, const DtString &userData)
virtual void	getGuiRuntimeLoadBalancingScheme (DtString &scheme, DtString &userData) const
virtual void	setSimulationModelSets (const std::vector< DtFilename > &)
virtual const std::vector < DtFilename > &	simulationModelSets () const
virtual void	clearSimulationModelSets ()
virtual void	setFrameRateMode (char)
virtual char	frameRateMode () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtU32	myVersion
bool	myIsTimeManaged
DtString	myScenarioName
DtFilename	myScenarioFilename
DtFilename	myTerrainName
DtFilename	myGuiTerrainName
std::vector< DtFilename >	mySimulationModelSets
DtRwKeyValueList	myScenarioData
DtU8	myFrameRateMode
DtString	myGuiRuntimeLoadBalancingScheme
DtString	myGuiRuntimeLoadBalancingSchemeData
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

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.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfScenarioStatus::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual const 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 const DtFilename& DtIfScenarioStatus::scenarioFilename ( ) const

virtual

The name of the scenario filename that is currently loaded, if any. If no scenario is loaded by the sim engine, this sill be a null string. This is the path to the file from the gui that has initiated the load. This is different than scenarioName in where the scenarioName is a short description of the scenario.

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

virtual

The name of the scenario filename that is currently loaded, if any. If no scenario is loaded by the sim engine, this sill be a null string. This is the path to the file from the gui that has initiated the load. This is different than scenarioName in where the scenarioName is a short description of the scenario.

virtual const DtFilename& 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 DtFilename &  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 const DtFilename& 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 DtFilename &  name )

virtual

The name of the terrain file loaded by the GUI. If null, then the GUI is loading terrainName().

virtual void DtIfScenarioStatus::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 DtIfScenarioStatus::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 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 void DtIfScenarioStatus::setFrameRateMode ( char  )

virtual

The frame rate mode of the scenario (see messageTypes.h)

virtual char DtIfScenarioStatus::frameRateMode ( ) const

virtual

The frame rate mode of the scenario (see messageTypes.h)

virtual const DtRwKeyValueList& DtIfScenarioStatus::scenarioData ( ) const

virtual

virtual DtRwKeyValueList& DtIfScenarioStatus::scenarioData ( )

virtual

virtual void DtIfScenarioStatus::setScenarioData ( const DtRwKeyValueList &  data )

virtual

virtual int DtIfScenarioStatus::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfScenarioStatus::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfScenarioStatus::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfScenarioStatus::creator ( )

static

Member Data Documentation

DtU32 DtIfScenarioStatus::myVersion

protected

bool DtIfScenarioStatus::myIsTimeManaged

protected

DtString DtIfScenarioStatus::myScenarioName

protected

DtFilename DtIfScenarioStatus::myScenarioFilename

protected

DtFilename DtIfScenarioStatus::myTerrainName

protected

DtFilename DtIfScenarioStatus::myGuiTerrainName

protected

std::vector<DtFilename> DtIfScenarioStatus::mySimulationModelSets

protected

DtRwKeyValueList DtIfScenarioStatus::myScenarioData

protected

DtU8 DtIfScenarioStatus::myFrameRateMode

protected

DtString DtIfScenarioStatus::myGuiRuntimeLoadBalancingScheme

protected

DtString DtIfScenarioStatus::myGuiRuntimeLoadBalancingSchemeData

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmsgs/ifScenarioStatus.h