 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Instances of DtVrfStatusPublisher are used to send information about a VR-Forces simulation engine to remote front ends or other control applications. More...
Public Member Functions | |
| DtVrfStatusPublisher (DtVrfMessageInterface *messageIf) | |
| constructor | |
| virtual | ~DtVrfStatusPublisher () |
| destructor | |
| virtual const DtSimulationAddress & | address () |
| virtual void | setAddress (const DtSimulationAddress &address) |
| virtual const DtTime & | lastResponseTime () |
| virtual void | setLastResponseTime (const DtTime &time) |
| virtual void | sendStatus (const DtSimulationAddress &address) |
| virtual void | sendFinalStatus () |
| virtual void | sendStatusToAll () |
| virtual void | setHeartbeatInterval (int heartbeatInterval) |
| This value determines how often to send out a status message. | |
| virtual int | heartbeatInterval () |
| virtual DtInetAddr | ipAddress () const |
| Get IP address of this backend. | |
| virtual void | setIpAddress (const DtInetAddr &addr) |
| virtual unsigned int | port () const |
| Get/Set our port number for file transferring. | |
| virtual void | setPort (unsigned int p) |
| virtual int | controlState () const |
| Get/Set control state (e.g. paused, running) | |
| virtual void | setControlState (int state) |
| virtual void | tick () |
| Ticked by the simulation manager. | |
| virtual void | processStatusRequestMessage (DtSimMessage *msg) |
| Process status request messages from other status managers. | |
| virtual bool | isLoaded () const |
| If true, this backend has been loaded with a scenario. | |
| virtual void | setIsLoaded (bool loaded) |
| virtual bool | isActive () const |
| The following functions are obsolete. | |
| virtual void | setIsActive (bool active) |
| virtual bool | canSimulate () const |
| virtual void | setCanSimulate (bool canSimulate) |
| virtual DtTime | exerciseStartTime () const |
| exercise start simulation time in seconds (defaults to 0.0). | |
| virtual void | setExerciseStartTime (DtTime time) |
| virtual DtTime | simTime () const |
| simulation time (simulation time elapsed since start of simulation) in seconds (defaults to 0.0). | |
| virtual void | setSimTime (DtTime time) |
| virtual DtTime | simStartSimTime () const |
| simulation time at start of simulation (defaults to 0.0). | |
| virtual void | setSimStartSimTime (DtTime time) |
| virtual double | timeMultiplier () const |
| Set faster or slower than real-time operation (defaults to 1.0). | |
| virtual void | setTimeMultiplier (double timeMultiplier) |
| virtual void | setLoadedNewScenario (bool) |
| Only sent once. | |
| virtual bool | loadedNewScenario () const |
| virtual bool | isCurrentParameterDb () const |
| Flag indicating whether parameter database is old file format or not. | |
| virtual void | setIsCurrentParameterDb (bool isCurrentParameterDb) |
| virtual bool | isResourceMonitorEnabled () const |
| Flag indicating if resource manager is enabled. | |
| virtual void | setIsResourceMonitorEnabled (bool isEnabled) |
| virtual void | setStealthRemoteController (DtStealthRemoteController *c) |
| For updating stealth time of day (if requested) | |
| virtual DtStealthRemoteController * | stealthRemoteController () const |
| virtual void | setPublishSimulationTimeForStealth (bool b) |
| If want to publish simulation time for stealth, check to see if it's time to so it here. | |
| virtual bool | publishSimulationTimeForStealth () const |
| virtual void | setIsTimeManaged (bool yesNo) |
| virtual bool | isTimeManaged () const |
| virtual void | setGuiTerrainName (const DtString &name) |
| virtual DtString | guiTerrainName () const |
| virtual void | setSendStatusOnChange (bool) |
| If true (default) will send status message when anything changes. | |
| virtual bool | sendStatusOnChange () const |
| virtual void | setTerrainName (const DtString &name) |
| The currently loaded terrain name. | |
| virtual DtString | terrainName () const |
| The currently loaded terrain name. | |
| virtual void | setScenarioName (const DtString &name) |
| The currently loaded scenario name. | |
| virtual DtString | scenarioName () const |
| The currently loaded scenario name. | |
Static Public Member Functions | |
| static void | statusRequestCallback (DtSimMessage *msg, void *usr) |
| Handle status request messages from other status managers. | |
Protected Member Functions | |
| virtual void | publishStealthSimulationTime () |
| Asks the stealth remote controller to publish simulation time. | |
| DtVrfStatusPublisher (const DtVrfStatusPublisher &orig) | |
| copy constructor | |
| DtVrfStatusPublisher & | operator= (const DtVrfStatusPublisher &orig) |
| assignment operator | |
Protected Attributes | |
| DtVrfMessageInterface * | myMessageIf |
| Status of this node. | |
| int | myHeartbeatInterval |
| DtSimulationAddress | myAddress |
| bool | myIsActive |
| bool | myCanSimulate |
| DtTime | myLastResponseTime |
| bool | myIsOldParameterDb |
| DtStealthRemoteController * | myStealthRemoteController |
| bool | myPublishSimulationTimeForStealth |
| bool | myHasBeenModified |
| bool | mySendStatusOnChange |
| bool | myLoadedNewScenario |
| DtIfStatus * | myStatus |
Instances of DtVrfStatusPublisher are used to send information about a VR-Forces simulation engine to remote front ends or other control applications.
| DtVrfStatusPublisher::DtVrfStatusPublisher | ( | DtVrfMessageInterface * | messageIf | ) |
constructor
| virtual DtVrfStatusPublisher::~DtVrfStatusPublisher | ( | ) | [virtual] |
destructor
| DtVrfStatusPublisher::DtVrfStatusPublisher | ( | const DtVrfStatusPublisher & | orig | ) | [protected] |
copy constructor
| virtual const DtSimulationAddress& DtVrfStatusPublisher::address | ( | ) | [virtual] |
| virtual void DtVrfStatusPublisher::setAddress | ( | const DtSimulationAddress & | address | ) | [virtual] |
| virtual const DtTime& DtVrfStatusPublisher::lastResponseTime | ( | ) | [virtual] |
| virtual void DtVrfStatusPublisher::setLastResponseTime | ( | const DtTime & | time | ) | [virtual] |
| virtual void DtVrfStatusPublisher::sendStatus | ( | const DtSimulationAddress & | address | ) | [virtual] |
| virtual void DtVrfStatusPublisher::sendFinalStatus | ( | ) | [virtual] |
| virtual void DtVrfStatusPublisher::sendStatusToAll | ( | ) | [virtual] |
| virtual void DtVrfStatusPublisher::setHeartbeatInterval | ( | int | heartbeatInterval | ) | [virtual] |
This value determines how often to send out a status message.
| virtual int DtVrfStatusPublisher::heartbeatInterval | ( | ) | [virtual] |
| virtual DtInetAddr DtVrfStatusPublisher::ipAddress | ( | ) | const [virtual] |
Get IP address of this backend.
| virtual void DtVrfStatusPublisher::setIpAddress | ( | const DtInetAddr & | addr | ) | [virtual] |
| virtual unsigned int DtVrfStatusPublisher::port | ( | ) | const [virtual] |
Get/Set our port number for file transferring.
| virtual void DtVrfStatusPublisher::setPort | ( | unsigned int | p | ) | [virtual] |
| virtual int DtVrfStatusPublisher::controlState | ( | ) | const [virtual] |
Get/Set control state (e.g. paused, running)
| virtual void DtVrfStatusPublisher::setControlState | ( | int | state | ) | [virtual] |
| virtual void DtVrfStatusPublisher::tick | ( | ) | [virtual] |
Ticked by the simulation manager.
| virtual void DtVrfStatusPublisher::processStatusRequestMessage | ( | DtSimMessage * | msg | ) | [virtual] |
Process status request messages from other status managers.
| static void DtVrfStatusPublisher::statusRequestCallback | ( | DtSimMessage * | msg, |
| void * | usr | ||
| ) | [static] |
Handle status request messages from other status managers.
| virtual bool DtVrfStatusPublisher::isLoaded | ( | ) | const [virtual] |
If true, this backend has been loaded with a scenario.
| virtual void DtVrfStatusPublisher::setIsLoaded | ( | bool | loaded | ) | [virtual] |
| virtual bool DtVrfStatusPublisher::isActive | ( | ) | const [virtual] |
The following functions are obsolete.
| virtual void DtVrfStatusPublisher::setIsActive | ( | bool | active | ) | [virtual] |
| virtual bool DtVrfStatusPublisher::canSimulate | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::setCanSimulate | ( | bool | canSimulate | ) | [virtual] |
| virtual DtTime DtVrfStatusPublisher::exerciseStartTime | ( | ) | const [virtual] |
exercise start simulation time in seconds (defaults to 0.0).
| virtual void DtVrfStatusPublisher::setExerciseStartTime | ( | DtTime | time | ) | [virtual] |
| virtual DtTime DtVrfStatusPublisher::simTime | ( | ) | const [virtual] |
simulation time (simulation time elapsed since start of simulation) in seconds (defaults to 0.0).
| virtual void DtVrfStatusPublisher::setSimTime | ( | DtTime | time | ) | [virtual] |
| virtual DtTime DtVrfStatusPublisher::simStartSimTime | ( | ) | const [virtual] |
simulation time at start of simulation (defaults to 0.0).
| virtual void DtVrfStatusPublisher::setSimStartSimTime | ( | DtTime | time | ) | [virtual] |
| virtual double DtVrfStatusPublisher::timeMultiplier | ( | ) | const [virtual] |
Set faster or slower than real-time operation (defaults to 1.0).
| virtual void DtVrfStatusPublisher::setTimeMultiplier | ( | double | timeMultiplier | ) | [virtual] |
| virtual void DtVrfStatusPublisher::setLoadedNewScenario | ( | bool | ) | [virtual] |
Only sent once.
Will be set then, once set, unset to signal a new scenario has just been loaded
| virtual bool DtVrfStatusPublisher::loadedNewScenario | ( | ) | const [virtual] |
| virtual bool DtVrfStatusPublisher::isCurrentParameterDb | ( | ) | const [virtual] |
Flag indicating whether parameter database is old file format or not.
Flag indicating if parameter database is current file format or not.
| virtual void DtVrfStatusPublisher::setIsCurrentParameterDb | ( | bool | isCurrentParameterDb | ) | [virtual] |
| virtual bool DtVrfStatusPublisher::isResourceMonitorEnabled | ( | ) | const [virtual] |
Flag indicating if resource manager is enabled.
When setting, if flag is different, status is published immediately
| virtual void DtVrfStatusPublisher::setIsResourceMonitorEnabled | ( | bool | isEnabled | ) | [virtual] |
| virtual void DtVrfStatusPublisher::setStealthRemoteController | ( | DtStealthRemoteController * | c | ) | [virtual] |
For updating stealth time of day (if requested)
| virtual DtStealthRemoteController* DtVrfStatusPublisher::stealthRemoteController | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::setPublishSimulationTimeForStealth | ( | bool | b | ) | [virtual] |
If want to publish simulation time for stealth, check to see if it's time to so it here.
| virtual bool DtVrfStatusPublisher::publishSimulationTimeForStealth | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::setIsTimeManaged | ( | bool | yesNo | ) | [virtual] |
| virtual bool DtVrfStatusPublisher::isTimeManaged | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::setTerrainName | ( | const DtString & | name | ) | [virtual] |
The currently loaded terrain name.
| virtual DtString DtVrfStatusPublisher::terrainName | ( | ) | const [virtual] |
The currently loaded terrain name.
| virtual void DtVrfStatusPublisher::setGuiTerrainName | ( | const DtString & | name | ) | [virtual] |
| virtual DtString DtVrfStatusPublisher::guiTerrainName | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::setScenarioName | ( | const DtString & | name | ) | [virtual] |
The currently loaded scenario name.
| virtual DtString DtVrfStatusPublisher::scenarioName | ( | ) | const [virtual] |
The currently loaded scenario name.
| virtual void DtVrfStatusPublisher::setSendStatusOnChange | ( | bool | ) | [virtual] |
If true (default) will send status message when anything changes.
If false, will set myHasBeenModified to true, and, if this is reset to true, will send message if if the myHasBeenModified flag is also true
| virtual bool DtVrfStatusPublisher::sendStatusOnChange | ( | ) | const [virtual] |
| virtual void DtVrfStatusPublisher::publishStealthSimulationTime | ( | ) | [protected, virtual] |
Asks the stealth remote controller to publish simulation time.
| DtVrfStatusPublisher& DtVrfStatusPublisher::operator= | ( | const DtVrfStatusPublisher & | orig | ) | [protected] |
assignment operator
DtVrfMessageInterface* DtVrfStatusPublisher::myMessageIf [protected] |
Status of this node.
int DtVrfStatusPublisher::myHeartbeatInterval [protected] |
DtSimulationAddress DtVrfStatusPublisher::myAddress [protected] |
bool DtVrfStatusPublisher::myIsActive [protected] |
bool DtVrfStatusPublisher::myCanSimulate [protected] |
DtTime DtVrfStatusPublisher::myLastResponseTime [protected] |
bool DtVrfStatusPublisher::myIsOldParameterDb [protected] |
bool DtVrfStatusPublisher::myHasBeenModified [protected] |
bool DtVrfStatusPublisher::mySendStatusOnChange [protected] |
bool DtVrfStatusPublisher::myLoadedNewScenario [protected] |
DtIfStatus* DtVrfStatusPublisher::myStatus [protected] |