DtLogger provides the core system structure and controls the execution model for the underlying objects. More...
Inheritance diagram for MAKLogger::DtLogger:
Collaboration diagram for MAKLogger::DtLogger:
Public Member Functions | |
| virtual void | init () |
| , Ticks the logger once. | |
| virtual void | registerSimulationProtocol (DtLgrProtocolRegistration *) |
| This method must be called by a simulation plug-in during initialization. | |
|
virtual const DtLgrProtocolRegistration * | simulationProtocol () const |
| Gets the protocol registration the logger was registered with. | |
| virtual bool | tick () |
| Tick the logger once, function is non-blocking. | |
| virtual DtRelativeTime | tickTime () const |
| Get the estimated time between ticks. | |
| virtual void | setTickTime (DtRelativeTime time) |
| Set the estimated time between tick calls. | |
| virtual void | submitCommand (const DtCommand &command) |
| Send a command to the logger to execute. | |
| virtual DtLgrCommandHandlerSP | getCommandHandler (const DtLgrCommandType &type) const |
| Lookup the command handler for a specific type of command. | |
| virtual const DtLibraryList & | libraries () const |
| Gets the Loaded libraries. | |
| virtual DtLgrSimManager * | simManager () |
| Access simulation manager;. | |
| DtLgrSystemDriver & | driver () |
| Get system driver. | |
Protected Attributes | |
| DtLgrProtocolRegistration * | myRegistration |
| DtLgrSystemDriver * | myDriver |
| The driver which defines the logger executions. | |
| DtRelativeTime | myTickTime |
| The time between ticks. | |
Static Protected Attributes | |
| static DtRelativeTime | theDefaultTickTime |
| Default tick time. | |
Detailed Description
DtLogger provides the core system structure and controls the execution model for the underlying objects.
Member Function Documentation
| virtual void MAKLogger::DtLogger::init | ( | ) | [virtual] |
, Ticks the logger once.
And ensures that the logger is in a valid state after the tick. Startup commands should be submitted before init. Init will throw if the logger is not in a valid state. Possible examples of invalid states include no simulation components loaded.
Reimplemented in MAKLogger::DtDisLogger.
| virtual void MAKLogger::DtLogger::registerSimulationProtocol | ( | DtLgrProtocolRegistration * | ) | [virtual] |
This method must be called by a simulation plug-in during initialization.
Additional calls may be made during initialization however once initialization is complete further calls will have no effect on the logger.
| virtual void MAKLogger::DtLogger::submitCommand | ( | const DtCommand & | command | ) | [virtual] |
Send a command to the logger to execute.
- Parameters:
-
Input command The logger command to be executed.
- Warning:
- The command will not be executed until tick is called.
| virtual bool MAKLogger::DtLogger::tick | ( | ) | [virtual] |
Tick the logger once, function is non-blocking.
This causes the logger to tick for one round of execution. Typically an application will have a loop where it ticks the logger.
- Returns:
- Returns whether the logger should continue to be ticked.
- Return values:
-
true The logger can still tick. false The logger should exit.
Reimplemented in MAKLogger::DtDisLogger.
Member Data Documentation
DtLgrSystemDriver* MAKLogger::DtLogger::myDriver [protected] |
The driver which defines the logger executions.
The logger is responsible for executing the driver.
The documentation for this class was generated from the following file: