DtBackend Class Reference

Instances of DtBackend are created and maintained by a DtVrfBackendListener, and are containers for datum associated with a back-end. More...

Public Types
enum	Status {   Unknown = 0, NotLoaded = 1, NotReady, Loaded,   Ready, Playing, Paused, Loading,   Closing, Saving, RollingBackScenario, ImportingScenario }
typedef std::map< short, int >	ObjectCounts

Public Member Functions
	DtBackend (const DtSimulationAddress &addr, const DtInetAddr &ipAddr, int port, int state, bool isLoaded, DtTime exerciseStartTime, DtTime simTime, double timeMultiplier, DtClock *clock)
	constructor More...
	DtBackend (const DtSimulationAddress &addr)
	DtBackend ()
	DtBackend (const DtBackend &)
virtual	~DtBackend ()
	destructor More...
DtBackend &	operator= (const DtBackend &)
virtual const DtSimulationAddress &	address () const
	returns the simulation address More...
virtual void	printStatus ()
	dumps member data to standard out More...
virtual Status	status () const
	Current status of the back-end based on various flag settings. More...
virtual bool	isInSimulatableState () const
	Returns true if the back-end is in a simulatable state. More...
virtual bool	isSimulatableStatus (DtBackend::Status) const
	Return true if the current status means the back-end can be simulated. More...
virtual bool	isInTransitionStatus () const
	Returns true if this is a transitional status (loading, saving, closing, etc) More...
virtual bool	isTransitionStatus (DtBackend::Status) const
virtual DtInetAddr	inetAddress () const
	accessor for inet address More...
virtual void	setInetAddress (DtInetAddr address)
	mutator for inet address More...
virtual unsigned int	port () const
	accessor for port number More...
virtual void	setPort (unsigned int port)
	mutator for port number More...
virtual int	controlState () const
	accessor for control state More...
virtual void	setControlState (int controlState)
	mutator for control state More...
virtual void	setScenarioRunId (int)
	If used, the unique id of this scenario run. More...
virtual int	scenarioRunId () const
virtual DtU32	scenarioCapabilities () const
	Indicates the capabilities this VRF based application. More...
virtual void	setScenarioCapabilities (const DtU32 &)
virtual void	setAppIdRangeMax (int)
	If this backend can support more than 65536 entities, the maximum app id that the back-end can take (starting at the default app id) before it runs out of space to create entities. More...
virtual int	appIdRangeMax () const
virtual bool	isLoaded () const
	accessor for loaded state. More...
virtual bool	isLoadedAndCanSimulate () const
virtual void	setIsLoaded (bool b)
	mutator for loaded state More...
virtual bool	canSimulate () const
	Accessor for simulation state. More...
virtual void	setCanSimulate (bool)
virtual bool	loadingScenario () const
	Accessor for a scenario being loaded. More...
virtual void	setLoadingScenario (bool)
virtual bool	savingScenario () const
	Accessor for a scenario being saved. More...
virtual void	setSavingScenario (bool)
virtual bool	importingScenario () const
	Accessor for a scenario being imported. More...
virtual void	setImportingScenario (bool)
virtual bool	reinitializingScenario () const
	Accessor for a scenario being reinitialized. More...
virtual void	setReinitializingScenario (bool)
virtual bool	hostingDynamicTerrainServer () const
	Accessor hosting dynamic terrain server. More...
virtual void	setHostingDynamicTerrainServer (bool)
virtual bool	creatingSimulationObjectGroup () const
	Accessor for a simulation object group being creating. More...
virtual void	setCreatingSimulationObjectGroup (bool)
virtual bool	closingScenario () const
	Accessor for a scenario being closed. More...
virtual void	setClosingScenario (bool)
virtual bool	rollingBackScenario () const
	Accessor for a scenario being rolled back. More...
virtual void	setRollingBackScenario (bool)
virtual bool	loadedNewScenario () const
	Accessor for a new scenario just been loaded. More...
virtual void	setLoadedNewScenario (bool)
virtual const DtTime &	lastResponseTime () const
	accessor for last response time More...
virtual void	setLastResponseTime (const DtTime &time)
	mutator for last response time More...
virtual double	frameRateMean () const
	accessor for frame rate mean a negative value indicates that no data has been sent More...
virtual void	setFrameRateMean (double frameRateMean)
virtual double	frameRateMedian () const
	accessor for frame rate median a negative value indicates that no data has been sent More...
virtual void	setFrameRateMedian (double frameRateMedian)
virtual double	frameRateStandardDeviation () const
	accessor for frame rate standard deviation a negative value indicates that no data has been sent More...
virtual void	setFrameRateStandardDeviation (double frameRateStandardDeviation)
virtual double	minFrameRate () const
	accessor for minimum frame time a negative value indicates that no data has been sent More...
virtual void	setMinFrameRate (double minFrameRate)
virtual double	maxFrameRate () const
	accessor for max frame time a negative value indicates that no data has been sent More...
virtual void	setMaxFrameRate (double maxFrameRate)
virtual void	setExericseStartTime (DtTime time)
	exericse start time in seconds. More...
virtual DtTime	exerciseStartTime ()
virtual void	setSimTime (DtTime time)
	simulation time (simulation time elapsed since start of simulation) in seconds. More...
virtual DtTime	simTime ()
virtual void	setRunDurationTime (DtTime)
	Amount of time simulation is scheduled to run. 0 means run until user stops. More...
virtual DtTime	runDurationTime () const
virtual void	setSimStartSimTime (DtTime time)
	simulation time at simulation load. More...
virtual DtTime	simStartSimTime () const
virtual void	setTimeMultiplier (double multiplier)
	Set faster or slower than real-time operation (defaults to 1.0). More...
virtual double	timeMultiplier () const
virtual void	setIsCurrentParameterDb (bool flag)
	flag indicating if parameter database loaded is current format or not. More...
virtual bool	isCurrentParameterDb () const
virtual void	setResourceMonitorEnabled (bool flag)
virtual bool	resourceMonitorEnabled () const
virtual void	setIsTimeManaged (bool)
	Returns true if back-end is time managed. Only valid for HLA. More...
virtual bool	isTimeManaged () const
virtual double	dT () const
	Returns delta time. More...
virtual const DtSettingsObject *	lookupSetting (std::string name) const
	Looks up a named DtSettingsObject. More...
virtual void	setSetting (const DtSettingsObject *object)
	Looks up the given setting by name in the settings map. More...
virtual void	copySettingsMap (const DtSettingsMap &)
	Copies settings from target into mySettingsMap. Removes all objects from settings map first. More...
virtual double	simTimeToRealTimeRatio () const
	Ratio of simulation time to real (wallclock) time. More...
virtual void	setSimTimeToRealTimeRatio (double ratio)
virtual void	setScenarioName (const DtString &name)
	The currently loaded scenario for backend, if any. More...
virtual const DtString &	scenarioName () const
virtual void	setScenarioFilename (const DtFilename &name)
	The currently loaded scenario file for backend, if any. More...
virtual const DtFilename &	scenarioFilename () const
virtual void	setSimulationModelSets (const std::vector< DtFilename > &)
	Simulation model sets in use. More...
virtual const std::vector < DtFilename > &	simulationModelSets () const
virtual void	setTerrainName (const DtFilename &name)
	The currently loaded terrain name, if any, for the backend. More...
virtual const DtFilename &	terrainName () const
virtual void	setGuiTerrainName (const DtFilename &name)
	The terrain file name which the backend currently believes the GUI should be loading to join the terrain. More...
virtual const DtFilename &	guiTerrainName () const
virtual void	setSimEngineId (DtU32 id)
	Unique identifier for a simulation engine. More...
virtual DtU32	simEngineId () const
virtual void	setObjectCounts (const std::map< DtU16, int > &)
virtual void	setObjectCounts (const ObjectCounts &)
virtual int	totalLocalObjects () const
const ObjectCounts &	objectCounts () const
virtual DtRwKeyValueList &	scenarioData ()
	Access the scenario data key value list. More...
virtual const DtRwKeyValueList &	scenarioData () const

Protected Attributes
DtSimulationAddress	myAddress
DtInetAddr	myInetAddr
DtU32	myPort
DtU16	myControlState
DtTime	myLastResponseTime
bool	myIsLoaded
bool	myCanSimulate
double	myFrameRateMean
	Frame rate information. More...
double	myFrameRateMedian
double	myFrameRateStandardDeviation
double	myMinFrameRate
double	myMaxFrameRate
double	mySimTimeToRealTimeRatio
DtTime	myExerciseStartTime
DtTime	mySimTime
DtTime	mySimStartSimTime
double	myTimeMultiplier
DtClock *	myClock
DtTime	myLastSimTimeUpdated
	wall-clock time elapsed since last sim time was updated More...
DtTime	myDt
	Duration of last frame (simulation time). More...
bool	myIsCurrentParameterDb
bool	myResourceMonitorEnabled
bool	myIsTimeManaged
DtString	myScenarioName
DtFilename	myScenarioFilename
DtFilename	myTerrainName
DtFilename	myGuiTerrainName
DtU32	mySimEngineId
DtSettingsMap	mySettingsMap
	Map of DtSettingsObjects. More...
int	myScenarioRunId
int	myAppIdRangeMax
bool	myLoadedNewScenario
bool	myLoadingScenario
bool	myImportingScenario
bool	myReinitializingScenario
bool	myClosingScenario
bool	myHostingDynamicTerrainServer
bool	myRollingBackScenario
bool	myCreatingSimulationObjectGroup
bool	mySavingScenario
ObjectCounts	myObjectCounts
std::vector< DtFilename >	mySimulationModelSets
DtTime	myRunDurationTime
DtRwKeyValueList	myScenarioData
DtU32	myScenarioCapabilities

Detailed Description

Instances of DtBackend are created and maintained by a DtVrfBackendListener, and are containers for datum associated with a back-end.

Member Typedef Documentation

typedef std::map<short, int> DtBackend::ObjectCounts

Member Enumeration Documentation

enum DtBackend::Status

Enumerator
Unknown	These flags will represent the status of a back-end that is retrieved by calling the status() method.
NotLoaded
NotReady	This back-end has no scenario loaded.
Loaded	This back-end cannot simulate a scenario.
Ready	Loaded but not ready to simulate.
Playing	This back-end is ready to simulate (i.e. can have simulation objects created on it and can be played)
Paused	This back-end is currently playing a scenario.
Loading	This back-end is currently paused.
Closing	This back-end is currently loading a scenario.
Saving	This back-end is currently closing a scenario.
RollingBackScenario	This back-end is currenty saving a scenario.
ImportingScenario	This back-end is rolling back a scenario. This back-end is importing a scenario

Constructor & Destructor Documentation

DtBackend::DtBackend	(	const DtSimulationAddress &	addr,
		const DtInetAddr &	ipAddr,
		int	port,
		int	state,
		bool	isLoaded,
		DtTime	exerciseStartTime,
		DtTime	simTime,
		double	timeMultiplier,
		DtClock *	clock
	)

constructor

DtBackend::DtBackend

(

const DtSimulationAddress &

addr

)

DtBackend::DtBackend

(

)

DtBackend::DtBackend

(

const DtBackend &

)

virtual DtBackend::~DtBackend ( )

virtual

destructor

Member Function Documentation

DtBackend& DtBackend::operator=

(

const DtBackend &

)

virtual const DtSimulationAddress& DtBackend::address ( ) const

virtual

returns the simulation address

virtual void DtBackend::printStatus ( )

virtual

dumps member data to standard out

virtual Status DtBackend::status ( ) const

virtual

Current status of the back-end based on various flag settings.

virtual bool DtBackend::isInSimulatableState ( ) const

virtual

Returns true if the back-end is in a simulatable state.

virtual bool DtBackend::isSimulatableStatus ( DtBackend::Status  ) const

virtual

Return true if the current status means the back-end can be simulated.

virtual bool DtBackend::isInTransitionStatus ( ) const

virtual

Returns true if this is a transitional status (loading, saving, closing, etc)

virtual bool DtBackend::isTransitionStatus ( DtBackend::Status  ) const

virtual

virtual DtInetAddr DtBackend::inetAddress ( ) const

virtual

accessor for inet address

virtual void DtBackend::setInetAddress ( DtInetAddr  address )

virtual

mutator for inet address

virtual unsigned int DtBackend::port ( ) const

virtual

accessor for port number

virtual void DtBackend::setPort ( unsigned int  port )

virtual

mutator for port number

virtual int DtBackend::controlState ( ) const

virtual

accessor for control state

virtual void DtBackend::setControlState ( int  controlState )

virtual

mutator for control state

virtual void DtBackend::setScenarioRunId ( int  )

virtual

If used, the unique id of this scenario run.

virtual int DtBackend::scenarioRunId ( ) const

virtual

virtual DtU32 DtBackend::scenarioCapabilities ( ) const

virtual

Indicates the capabilities this VRF based application.

This doesn't specifically limit the capabilities of this class, but publishes this capabilities as part of the status, changing the way a VRF GUI or remote control application interacts with this application.

See Also

DtScenarioCapabilities

virtual void DtBackend::setScenarioCapabilities ( const DtU32 &  )

virtual

virtual void DtBackend::setAppIdRangeMax ( int  )

virtual

If this backend can support more than 65536 entities, the maximum app id that the back-end can take (starting at the default app id) before it runs out of space to create entities.

This range cannot overlay with other back-end ranges. -1 means that there can only be the one app id

virtual int DtBackend::appIdRangeMax ( ) const

virtual

virtual bool DtBackend::isLoaded ( ) const

virtual

accessor for loaded state.

It used to be that isLoaded() would be false if the back-end could also not simulate. This has been changed. If you wish to have the old behavior, call isLoadedAndCanSimulate. This isLoaded() just returns the value of the myIsLoaded flag.

virtual bool DtBackend::isLoadedAndCanSimulate ( ) const

virtual

virtual void DtBackend::setIsLoaded ( bool  b )

virtual

mutator for loaded state

virtual bool DtBackend::canSimulate ( ) const

virtual

Accessor for simulation state.

virtual void DtBackend::setCanSimulate ( bool  )

virtual

virtual bool DtBackend::loadingScenario ( ) const

virtual

Accessor for a scenario being loaded.

virtual void DtBackend::setLoadingScenario ( bool  )

virtual

virtual bool DtBackend::savingScenario ( ) const

virtual

Accessor for a scenario being saved.

virtual void DtBackend::setSavingScenario ( bool  )

virtual

virtual bool DtBackend::importingScenario ( ) const

virtual

Accessor for a scenario being imported.

virtual void DtBackend::setImportingScenario ( bool  )

virtual

virtual bool DtBackend::reinitializingScenario ( ) const

virtual

Accessor for a scenario being reinitialized.

virtual void DtBackend::setReinitializingScenario ( bool  )

virtual

virtual bool DtBackend::hostingDynamicTerrainServer ( ) const

virtual

Accessor hosting dynamic terrain server.

virtual void DtBackend::setHostingDynamicTerrainServer ( bool  )

virtual

virtual bool DtBackend::creatingSimulationObjectGroup ( ) const

virtual

Accessor for a simulation object group being creating.

virtual void DtBackend::setCreatingSimulationObjectGroup ( bool  )

virtual

virtual bool DtBackend::closingScenario ( ) const

virtual

Accessor for a scenario being closed.

virtual void DtBackend::setClosingScenario ( bool  )

virtual

virtual bool DtBackend::rollingBackScenario ( ) const

virtual

Accessor for a scenario being rolled back.

virtual void DtBackend::setRollingBackScenario ( bool  )

virtual

virtual bool DtBackend::loadedNewScenario ( ) const

virtual

Accessor for a new scenario just been loaded.

virtual void DtBackend::setLoadedNewScenario ( bool  )

virtual

virtual const DtTime& DtBackend::lastResponseTime ( ) const

virtual

accessor for last response time

virtual void DtBackend::setLastResponseTime ( const DtTime &  time )

virtual

mutator for last response time

virtual double DtBackend::frameRateMean ( ) const

virtual

accessor for frame rate mean a negative value indicates that no data has been sent

virtual void DtBackend::setFrameRateMean ( double  frameRateMean )

virtual

virtual double DtBackend::frameRateMedian ( ) const

virtual

accessor for frame rate median a negative value indicates that no data has been sent

virtual void DtBackend::setFrameRateMedian ( double  frameRateMedian )

virtual

virtual double DtBackend::frameRateStandardDeviation ( ) const

virtual

accessor for frame rate standard deviation a negative value indicates that no data has been sent

virtual void DtBackend::setFrameRateStandardDeviation ( double  frameRateStandardDeviation )

virtual

virtual double DtBackend::minFrameRate ( ) const

virtual

accessor for minimum frame time a negative value indicates that no data has been sent

virtual void DtBackend::setMinFrameRate ( double  minFrameRate )

virtual

virtual double DtBackend::maxFrameRate ( ) const

virtual

accessor for max frame time a negative value indicates that no data has been sent

virtual void DtBackend::setMaxFrameRate ( double  maxFrameRate )

virtual

virtual double DtBackend::simTimeToRealTimeRatio ( ) const

virtual

Ratio of simulation time to real (wallclock) time.

virtual void DtBackend::setSimTimeToRealTimeRatio ( double  ratio )

virtual

virtual void DtBackend::setExericseStartTime ( DtTime  time )

virtual

exericse start time in seconds.

virtual DtTime DtBackend::exerciseStartTime ( )

virtual

virtual void DtBackend::setSimTime ( DtTime  time )

virtual

simulation time (simulation time elapsed since start of simulation) in seconds.

virtual DtTime DtBackend::simTime ( )

virtual

virtual void DtBackend::setRunDurationTime ( DtTime  )

virtual

Amount of time simulation is scheduled to run. 0 means run until user stops.

virtual DtTime DtBackend::runDurationTime ( ) const

virtual

virtual void DtBackend::setSimStartSimTime ( DtTime  time )

virtual

simulation time at simulation load.

virtual DtTime DtBackend::simStartSimTime ( ) const

virtual

virtual void DtBackend::setTimeMultiplier ( double  multiplier )

virtual

Set faster or slower than real-time operation (defaults to 1.0).

virtual double DtBackend::timeMultiplier ( ) const

virtual

virtual void DtBackend::setIsCurrentParameterDb ( bool  flag )

virtual

flag indicating if parameter database loaded is current format or not.

virtual bool DtBackend::isCurrentParameterDb ( ) const

virtual

virtual void DtBackend::setResourceMonitorEnabled ( bool  flag )

virtual

virtual bool DtBackend::resourceMonitorEnabled ( ) const

virtual

virtual void DtBackend::setIsTimeManaged ( bool  )

virtual

Returns true if back-end is time managed. Only valid for HLA.

virtual bool DtBackend::isTimeManaged ( ) const

virtual

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

virtual

The currently loaded scenario for backend, if any.

virtual const DtString& DtBackend::scenarioName ( ) const

virtual

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

virtual

The currently loaded scenario file for backend, if any.

Different than scenarioName which is a short description of the scenario

virtual const DtFilename& DtBackend::scenarioFilename ( ) const

virtual

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

virtual

Simulation model sets in use.

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

virtual

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

virtual

The currently loaded terrain name, if any, for the backend.

virtual const DtFilename& DtBackend::terrainName ( ) const

virtual

virtual double DtBackend::dT ( ) const

virtual

Returns delta time.

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

virtual

The terrain file name which the backend currently believes the GUI should be loading to join the terrain.

virtual const DtFilename& DtBackend::guiTerrainName ( ) const

virtual

virtual void DtBackend::setSimEngineId ( DtU32  id )

virtual

Unique identifier for a simulation engine.

virtual DtU32 DtBackend::simEngineId ( ) const

virtual

virtual const DtSettingsObject* DtBackend::lookupSetting ( std::string  name ) const

virtual

Looks up a named DtSettingsObject.

Note that DtSettingsObjects are not automatically published from the back-end; they must be requested by calling DtVrfBackendListener::requestBackendSetting.

virtual void DtBackend::setSetting ( const DtSettingsObject *  object )

virtual

Looks up the given setting by name in the settings map.

If the setting already exists, it's contents will be overwritten with the new object. Otherwise, a clone of the object is added to the settings map. DtBackend does not assume ownership of objects passed into this function.

virtual void DtBackend::copySettingsMap ( const DtSettingsMap &  )

virtual

Copies settings from target into mySettingsMap. Removes all objects from settings map first.

virtual void DtBackend::setObjectCounts ( const std::map< DtU16, int > &  )

virtual

Deals with locally published objects. Keys are stored as high char of kind and low char of domain with the count of each

virtual void DtBackend::setObjectCounts ( const ObjectCounts &  )

virtual

virtual int DtBackend::totalLocalObjects ( ) const

virtual

const ObjectCounts& DtBackend::objectCounts ( ) const

inline

virtual DtRwKeyValueList& DtBackend::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& DtBackend::scenarioData ( ) const

virtual

Member Data Documentation

DtSimulationAddress DtBackend::myAddress

protected

DtInetAddr DtBackend::myInetAddr

protected

DtU32 DtBackend::myPort

protected

DtU16 DtBackend::myControlState

protected

DtTime DtBackend::myLastResponseTime

protected

bool DtBackend::myIsLoaded

protected

bool DtBackend::myCanSimulate

protected

double DtBackend::myFrameRateMean

protected

Frame rate information.

double DtBackend::myFrameRateMedian

protected

double DtBackend::myFrameRateStandardDeviation

protected

double DtBackend::myMinFrameRate

protected

double DtBackend::myMaxFrameRate

protected

double DtBackend::mySimTimeToRealTimeRatio

protected

DtTime DtBackend::myExerciseStartTime

protected

DtTime DtBackend::mySimTime

protected

DtTime DtBackend::mySimStartSimTime

protected

double DtBackend::myTimeMultiplier

protected

DtClock* DtBackend::myClock

protected

DtTime DtBackend::myLastSimTimeUpdated

protected

wall-clock time elapsed since last sim time was updated

DtTime DtBackend::myDt

protected

Duration of last frame (simulation time).

bool DtBackend::myIsCurrentParameterDb

protected

bool DtBackend::myResourceMonitorEnabled

protected

bool DtBackend::myIsTimeManaged

protected

DtString DtBackend::myScenarioName

protected

DtFilename DtBackend::myScenarioFilename

protected

DtFilename DtBackend::myTerrainName

protected

DtFilename DtBackend::myGuiTerrainName

protected

DtU32 DtBackend::mySimEngineId

protected

DtSettingsMap DtBackend::mySettingsMap

protected

Map of DtSettingsObjects.

int DtBackend::myScenarioRunId

protected

int DtBackend::myAppIdRangeMax

protected

bool DtBackend::myLoadedNewScenario

protected

bool DtBackend::myLoadingScenario

protected

bool DtBackend::myImportingScenario

protected

bool DtBackend::myReinitializingScenario

protected

bool DtBackend::myClosingScenario

protected

bool DtBackend::myHostingDynamicTerrainServer

protected

bool DtBackend::myRollingBackScenario

protected

bool DtBackend::myCreatingSimulationObjectGroup

protected

bool DtBackend::mySavingScenario

protected

ObjectCounts DtBackend::myObjectCounts

protected

std::vector<DtFilename> DtBackend::mySimulationModelSets

protected

DtTime DtBackend::myRunDurationTime

protected

DtRwKeyValueList DtBackend::myScenarioData

protected

DtU32 DtBackend::myScenarioCapabilities

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/backend.h