![]() |
MAK Data Logger API Documentation for HLA
|
The abstract interface for the class responsible for controlling the simulation. More...
Inheritance diagram for MAKLogger::DtLgrSimDriver:
Collaboration diagram for MAKLogger::DtLgrSimDriver:Public Types | |
| typedef DtLgrSimCommandFactory | Factory |
| typedef DtLgrSimInterface | Interface |
| typedef std::pair< double, bool > | HeartbeatTimeRecord |
| Heartbeat time (seconds), inheritable flag (ignored in DIS) | |
Public Member Functions | |
| DtLgrSimDriver (DtLgrSystemDriver &systemDriver) | |
| Constructor. | |
| virtual | ~DtLgrSimDriver () |
| Destructor. | |
| virtual void | tick () |
| Tick the driver. | |
| virtual bool | releasePipeline () |
| Ask the driver to release the pipeline. | |
| bool | getPipeline () |
| Have the driver attempt to acquire the message pipeline. | |
| bool | hasPipeline () const |
| Check to see if the driver has the message pipeline. | |
| virtual bool | isConnected () const =0 |
| Get whether the simulation is connected. | |
| virtual void | addPacketFilter (DtLgrPacketFilter *filter) |
| Add a packet filter object. | |
| virtual void | removeFilter (const DtLgrPacketFilter *filter) |
| Remove a packet filter object. | |
| virtual bool | activity () const |
| Get whether there is simulation activity (this tick). | |
| virtual int | filterCount () const |
| Get the number of filters added. | |
| virtual const DtLgrPacketFilter * | filter (int index) const |
| Get a filter based on an index from 0 to filterCount(). | |
| virtual DtLgrPlaybackDriver * | getPlaybackDriver (bool checkForFileOpen) const |
| Get the playback driver. Throw if can't get it or checking file open and its not. | |
| virtual DtLgrRecordDriver * | getRecordDriver (bool checkForFileOpen) const |
| Get the playback driver. Throw if can't get it or checking file open and its not. | |
| virtual bool | processRemoteControls () const |
| Get whether remove control messages are processed. | |
| virtual bool | recordRemoteControls () const |
| Get whether remove control messages are recorded. | |
| virtual bool | allowAllRemoteControls () const |
| Get whether remote control messages process regardless of site ID. | |
| virtual bool | allowRemoteDelete () const |
| Get whether remove delete messages are processed. | |
| virtual bool | sendResponses () const |
| Get whether to send responses. | |
| virtual bool | crippleGui () const |
| Get whether to cripple the GUI (i.e., disable mouse clicks and minimize window) | |
| virtual bool | useLegacyPdu () const |
| Get whether to use legacy control PDU. | |
| virtual bool | saveConnectConfiguration () const |
| Get whether to save connection configuration. | |
| virtual bool | saveIndexConfiguration () const |
| Get whether to save checkpoint configuration. | |
| virtual bool | saveProtocolConfiguration () const |
| Get whether to save connection configuration. | |
| virtual bool | listenWhenIdle () const |
| Get whether listen when idle is enabled. | |
| virtual bool | staticDRAlgorithmWhenPaused () const |
| Get whether to set Static DR Algorithm when Paused. | |
| virtual void | activateIdleListening () |
| Activate idle listening. | |
| virtual bool | isSimTimeAdjusted () const |
| Get whether sim time is adjusted. | |
| virtual DtTime | connectSendInterval () const |
| Connect messages are sent using this interval. | |
| virtual DtTime | heartbeatSendInterval () const |
| Logger heartbeat messages are sent using this interval. | |
| virtual bool | useSimChannel () const |
| Use the sim channel connection? | |
| virtual bool | useBackChannel () const |
| Use the back channel connection? | |
| virtual const DtString & | backChannelAddress () const |
| Back channel connection address. | |
| virtual int | backChannelPort () const |
| Back Channel port. | |
| virtual const DtString & | backChannelInterface () const |
| Back Channel interface. | |
| virtual bool | scaleAttributes () const |
| Get whether attributes are scaled. | |
| virtual const std::map < DtString, DtLgrSimDriver::HeartbeatTimeRecord > & | heartbeatIntervals () const |
| Return a const reference to the heartbeat interval table. | |
| virtual const std::map < DtString, DtLgrSimDriver::HeartbeatTimeRecord > & | timeoutIntervals () const |
| Return a const reference to the timeout interval table. | |
| virtual void | updateEntityTracker (const DtString &tracker) |
| Update the driver's entity tracker to match argument. | |
| virtual DtLgrEntityTracker * | entityTracker () |
| Get the current entity tracker, or null if none. | |
| virtual void | addTemporaryTrackedEntity (const DtString &name) |
| virtual void | addTemporaryTrackedMarking (const DtString &marking) |
| virtual DtLgrSystemDriver * | systemDriver () |
| Get the system driver. | |
| virtual const DtLgrSystemDriver * | systemDriver () const |
| Get the system driver. | |
| virtual DtLgrSimManager * | simManager ()=0 |
| Get the simulation manager. | |
| virtual const DtLgrSimManager * | simManager () const =0 |
| Get the simulation manager. | |
Public Member Functions inherited from MAKLogger::DtLgrCommandHandler | |
| DtLgrCommandHandler (const DtString &name, DtRuntimeCommandFactory *, DtCommandDispatcherSP) | |
| Constructor which provides the name, the runtime factory, and the dispatcher which receives and transmits commands. | |
| virtual | ~DtLgrCommandHandler () |
| DTOR. | |
| void | lock () |
| Locks the Command Handler. | |
| void | unlock () |
| Unlocks the Command Handler. | |
| DtCommandDispatcherSP | dispatcher () |
| Get the dispatcher the command handler is connected to. | |
| virtual const DtString & | driverName () const |
| Get the name of the driver. | |
| virtual const DtString & | driverInfo () |
| Get the name of the driver. | |
| virtual void | processCommand (const DtCommand &command) |
| Process a specific command. | |
| virtual bool | spawnThread (DtLgrCommandThread *commandThread) |
| Spawn a new thread. | |
| virtual void | stopAllThreads () |
| Stop all running threads. | |
| virtual void | stopThread (DtLgrCommandThread *commandThread) |
| Stop a thread and deallocate it's resources. | |
Static Public Member Functions | |
| static DtLgrSimDriver * | getFromLogger (const DtLogger &logger) |
| Get the sim driver used by the Logger object. | |
Protected Member Functions | |
| virtual void | setActivity (bool activity) |
| Set whether there is activity this tick. | |
| virtual void | setVRFMessageFiltering (bool filter, int lowId, int hiId) |
| Set the VRF Filtering. | |
| virtual void | configureConnectionInitalizer (DtExerciseConnInitializer &connInitializer)=0 |
| Configure the exercise connection initializer. | |
Command Handlers | |
| virtual DtResponse | addFilter (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | connect (const DtCommand &command)=0 |
| Add a packet filter object. | |
| virtual DtResponse | connectShared (const DtCommand &command)=0 |
| Add a packet filter object. | |
| virtual DtResponse | disconnect (const DtCommand &command)=0 |
| Add a packet filter object. | |
| virtual DtResponse | setSaveConnectConfiguration (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setSaveIndexConfiguration (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setSaveProtocolConfiguration (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setFilterSettings (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setScaleAttributes (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setVRFFiltering (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | addFilteredEntityName (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | clearFilteredEntityNames (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setHeartbeatIntervals (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setTimeoutIntervals (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | addTemporaryTrackedEntity (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setPlaybackFilesUseRandomAccess (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setExtendedStopTimeoutInterval (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setListenWhenIdle (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setAdjustSimTime (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setStaticDRAlgorithmWhenPaused (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | filterMarkings (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setRemoteControlSettings (const DtCommand &command) |
| Set the remote control settings. | |
| virtual DtResponse | setBackChannelConnection (const DtCommand &command) |
| Add a packet filter object. | |
| virtual DtResponse | setRemoteControlId (const DtCommand &command) |
| Add a packet filter object. | |
Protected Member Functions inherited from MAKLogger::DtLgrCommandHandler | |
| void | addCommandHandler (const DtCommandDefinition &commandDef, DtCommandFunctorSP commandFunctor) |
| Add a commandHandler, this should not be virtual as it is called in constructors. | |
| void | removeCommandHandler (const DtCommandDefinition &commandDef) |
| Remove a commandHandler, this is typically not called but necessary for replacing a command handler. | |
| virtual void | sendResponse (DtResponse response) |
| Send a response, for functions that have multiple responses make this call. | |
| virtual void | queueResponse (DtResponse response) |
| Queue a response for future sending. | |
| virtual void | sendQueuedResponses () |
| Sends all queued responses and clears the queue. | |
| virtual void | emptyResponseQueue () |
| Empty the response queue (deleting any unsent responses). | |
| DtResponse | finishThread (const DtCommand &command) |
| Finish the thread. | |
Additional Inherited Members | |
Protected Types inherited from MAKLogger::DtLgrCommandHandler | |
| typedef DtLgrCommandHandler *(* | DriverCreator )(DtCommandDispatcherSP) |
| typedef std::map < DtLgrCommandId, DtCommandFunctorSP > | DtLgrCommandHandlerMap |
| typedef std::map< DtString, DtLgrCommandId > | DtLgrCommandNameMap |
| typedef std::list< DtResponse > | DtResponseQueue |
| typedef std::map < DtLgrCommandThread *, DtThread * > | CommandThreadMap |
| A set of running command threads. | |
The abstract interface for the class responsible for controlling the simulation.
| typedef std::pair<double, bool> MAKLogger::DtLgrSimDriver::HeartbeatTimeRecord |
Heartbeat time (seconds), inheritable flag (ignored in DIS)
| MAKLogger::DtLgrSimDriver::DtLgrSimDriver | ( | DtLgrSystemDriver & | systemDriver | ) |
Constructor.
|
virtual |
Destructor.
|
virtual |
Activate idle listening.
|
virtual |
Get whether there is simulation activity (this tick).
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
virtual |
Add a packet filter object.
|
virtual |
|
protectedvirtual |
Add a packet filter object.
|
virtual |
|
virtual |
Get whether remote control messages process regardless of site ID.
|
virtual |
Get whether remove delete messages are processed.
|
virtual |
Back channel connection address.
|
virtual |
Back Channel interface.
|
virtual |
Back Channel port.
|
protectedvirtual |
Add a packet filter object.
|
protectedpure virtual |
Configure the exercise connection initializer.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
protectedpure virtual |
Add a packet filter object.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Connect messages are sent using this interval.
|
protectedpure virtual |
Add a packet filter object.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Get whether to cripple the GUI (i.e., disable mouse clicks and minimize window)
|
protectedpure virtual |
Add a packet filter object.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Get the current entity tracker, or null if none.
|
virtual |
Get a filter based on an index from 0 to filterCount().
|
virtual |
Get the number of filters added.
|
protectedvirtual |
Add a packet filter object.
|
static |
Get the sim driver used by the Logger object.
|
virtual |
Have the driver attempt to acquire the message pipeline.
Implements MAKLogger::DtLgrCommandHandler.
|
virtual |
Get the playback driver. Throw if can't get it or checking file open and its not.
|
virtual |
Get the playback driver. Throw if can't get it or checking file open and its not.
|
virtual |
Check to see if the driver has the message pipeline.
Implements MAKLogger::DtLgrCommandHandler.
|
virtual |
Return a const reference to the heartbeat interval table.
|
virtual |
Logger heartbeat messages are sent using this interval.
|
pure virtual |
Get whether the simulation is connected.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Get whether sim time is adjusted.
|
virtual |
Get whether listen when idle is enabled.
|
virtual |
Get whether remove control messages are processed.
|
virtual |
Get whether remove control messages are recorded.
|
virtual |
Ask the driver to release the pipeline.
This function is called when the pipeline has been requested by a different driver. If the driver can't release the pipeline it will return false. By default this method simply succeeds. If the driver should override this function if it wishes to deny the request.
| true | The pipeline has been released. |
| false | The pipeline has not been released. |
Implements MAKLogger::DtLgrCommandHandler.
|
virtual |
Remove a packet filter object.
|
virtual |
Get whether to save connection configuration.
|
virtual |
Get whether to save checkpoint configuration.
|
virtual |
Get whether to save connection configuration.
|
virtual |
Get whether attributes are scaled.
|
virtual |
Get whether to send responses.
|
protectedvirtual |
Set whether there is activity this tick.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Set the remote control settings.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Add a packet filter object.
|
protectedvirtual |
Set the VRF Filtering.
|
pure virtual |
Get the simulation manager.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
pure virtual |
Get the simulation manager.
Implemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Get whether to set Static DR Algorithm when Paused.
|
virtual |
Get the system driver.
Reimplemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Get the system driver.
Reimplemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Tick the driver.
Implements MAKLogger::DtLgrCommandHandler.
Reimplemented in MAKLogger::DtLgrHlaSimDriver.
|
virtual |
Return a const reference to the timeout interval table.
|
virtual |
Update the driver's entity tracker to match argument.
|
virtual |
Use the back channel connection?
|
virtual |
Get whether to use legacy control PDU.
|
virtual |
Use the sim channel connection?
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |