![]() |
VR-Forces 4.0.4 Class Documentation
|
Instances of DtBackend are created and maintained by a DtVrfBackendListener, and are containers for datum associated with a back-end. More...
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 | |
| DtBackend () | |
| DtBackend (const DtBackend &) | |
| virtual | ~DtBackend () |
| destructor | |
| DtBackend & | operator= (const DtBackend &) |
| virtual const DtSimulationAddress & | address () const |
| returns the simulation address | |
| virtual void | printStatus () |
| dumps member data to standard out | |
| virtual DtInetAddr | inetAddress () const |
| accessor for inet address | |
| virtual void | setInetAddress (DtInetAddr address) |
| mutator for inet address | |
| virtual unsigned int | port () const |
| accessor for port number | |
| virtual void | setPort (unsigned int port) |
| mutator for port number | |
| virtual int | controlState () const |
| accessor for control state | |
| virtual void | setControlState (int controlState) |
| mutator for control state | |
| virtual bool | isLoaded () const |
| accessor for loaded state | |
| virtual void | setIsLoaded (bool b) |
| mutator for loaded state | |
| virtual bool | canSimulate () const |
| Accessor for simulation state. | |
| virtual void | setCanSimulate (bool) |
| virtual bool | loadedNewScenario () const |
| Accessor for a new scenario just been loaded. | |
| virtual void | setLoadedNewScenario (bool) |
| virtual const DtTime & | lastResponseTime () const |
| accessor for last response time | |
| virtual void | setLastResponseTime (const DtTime &time) |
| mutator for last response time | |
| virtual double | frameRateMean () const |
| accessor for frame rate mean a negative value indicates that no data has been sent | |
| virtual void | setFrameRateMean (double frameRateMean) |
| virtual double | frameRateMedian () const |
| accessor for frame rate median a negative value indicates that no data has been sent | |
| 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 | |
| virtual void | setFrameRateStandardDeviation (double frameRateStandardDeviation) |
| virtual double | minFrameRate () const |
| accessor for minimum frame time a negative value indicates that no data has been sent | |
| virtual void | setMinFrameRate (double minFrameRate) |
| virtual double | maxFrameRate () const |
| accessor for max frame time a negative value indicates that no data has been sent | |
| virtual void | setMaxFrameRate (double maxFrameRate) |
| virtual void | setExericseStartTime (DtTime time) |
| exericse start time in seconds. | |
| virtual DtTime | exerciseStartTime () |
| virtual void | setSimTime (DtTime time) |
| simulation time (simulation time elapsed since start of simulation) in seconds. | |
| virtual DtTime | simTime () |
| virtual void | setSimStartSimTime (DtTime time) |
| simulation time at simulation load. | |
| virtual DtTime | simStartSimTime () const |
| virtual void | setTimeMultiplier (double multiplier) |
| Set faster or slower than real-time operation (defaults to 1.0). | |
| virtual double | timeMultiplier () const |
| virtual void | setIsCurrentParameterDb (bool flag) |
| flag indicating if parameter database loaded is current format or not. | |
| 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. | |
| virtual bool | isTimeManaged () const |
| virtual double | dT () const |
| Returns delta time. | |
| virtual const DtSettingsObject * | lookupSetting (std::string name) const |
| Looks up a named DtSettingsObject. | |
| virtual void | setSetting (const DtSettingsObject *object) |
| Looks up the given setting by name in the settings map. | |
| virtual void | copySettingsMap (const DtSettingsMap &) |
| Copies settings from target into mySettingsMap. Removes all objects from settings map first. | |
| virtual double | simTimeToRealTimeRatio () const |
| Ratio of simulation time to real (wallclock) time. | |
| virtual void | setSimTimeToRealTimeRatio (double ratio) |
| Ratio of simulation time to real (wallclock) time. | |
| virtual void | setScenarioName (const DtString &name) |
| The currently loaded scenario for backend, if any. | |
| virtual DtString | scenarioName () const |
| The currently loaded scenario for backend, if any. | |
| virtual void | setTerrainName (const DtString &name) |
| The currently loaded terrain name, if any, for the backend. | |
| virtual DtString | terrainName () const |
| The currently loaded terrain name, if any, for the backend. | |
| virtual void | setGuiTerrainName (const DtString &name) |
| The terrain file name which the backend currently believes the GUI should be loading to join the terrain. | |
| virtual DtString | guiTerrainName () const |
| The terrain file name which the backend currently believes the GUI should be loading to join the terrain. | |
| virtual void | setSimEngineId (DtU32 id) |
| Unique identifier for a simulation engine. | |
| virtual DtU32 | simEngineId () const |
| Unique identifier for a simulation engine. | |
Protected Attributes | |
| DtSimulationAddress | myAddress |
| DtInetAddr | myInetAddr |
| DtU32 | myPort |
| DtU16 | myControlState |
| DtTime | myLastResponseTime |
| bool | myIsLoaded |
| bool | myCanSimulate |
| double | myFrameRateMean |
| Frame rate information. | |
| 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 | |
| DtTime | myDt |
| Duration of last frame (simulation time). | |
| bool | myIsCurrentParameterDb |
| bool | myResourceMonitorEnabled |
| bool | myIsTimeManaged |
| DtString | myScenarioName |
| DtString | myTerrainName |
| DtString | myGuiTerrainName |
| DtU32 | mySimEngineId |
| DtSettingsMap | mySettingsMap |
| Map of DtSettingsObjects. | |
| bool | myLoadedNewScenario |
Instances of DtBackend are created and maintained by a DtVrfBackendListener, and are containers for datum associated with a back-end.
| 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 DtBackend & | ) |
| virtual DtBackend::~DtBackend | ( | ) | [virtual] |
destructor
| virtual const DtSimulationAddress& DtBackend::address | ( | ) | const [virtual] |
returns the simulation address
| virtual void DtBackend::printStatus | ( | ) | [virtual] |
dumps member data to standard out
| 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 bool DtBackend::isLoaded | ( | ) | const [virtual] |
accessor for loaded state
| 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::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] |
Ratio of simulation time to real (wallclock) time.
| 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::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 DtString DtBackend::scenarioName | ( | ) | const [virtual] |
The currently loaded scenario for backend, if any.
| virtual void DtBackend::setTerrainName | ( | const DtString & | name | ) | [virtual] |
The currently loaded terrain name, if any, for the backend.
| virtual DtString DtBackend::terrainName | ( | ) | const [virtual] |
The currently loaded terrain name, if any, for the backend.
| virtual double DtBackend::dT | ( | ) | const [virtual] |
Returns delta time.
| virtual void DtBackend::setGuiTerrainName | ( | const DtString & | name | ) | [virtual] |
The terrain file name which the backend currently believes the GUI should be loading to join the terrain.
| virtual DtString DtBackend::guiTerrainName | ( | ) | const [virtual] |
The terrain file name which the backend currently believes the GUI should be loading to join the terrain.
| virtual void DtBackend::setSimEngineId | ( | DtU32 | id | ) | [virtual] |
Unique identifier for a simulation engine.
| virtual DtU32 DtBackend::simEngineId | ( | ) | const [virtual] |
Unique identifier for a simulation engine.
| 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.
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] |
DtString DtBackend::myTerrainName [protected] |
DtString DtBackend::myGuiTerrainName [protected] |
DtU32 DtBackend::mySimEngineId [protected] |
DtSettingsMap DtBackend::mySettingsMap [protected] |
Map of DtSettingsObjects.
bool DtBackend::myLoadedNewScenario [protected] |