#include <WsfSimulationObserver.hpp>
Detailed Description
The implementation of the Simulation observer objects. An instance of this class is maintained by the simulation.
Member Data Documentation
◆ AdvanceTime
| WsfObserver::AdvanceTimeCallback WsfSimulationObserver::AdvanceTime |
The simulation is advancing to the specified time.
- Parameters
-
aSimTime The current simulation time.
◆ ApplicationExit
| WsfObserver::ApplicationExitCallback WsfSimulationObserver::ApplicationExit |
The application is exiting normally. Subscribers will be called in FILO order.
◆ ApplicationInitialize
| WsfObserver::ApplicationInitializeCallback WsfSimulationObserver::ApplicationInitialize |
The application is initializing.
◆ FrameComplete
| WsfObserver::FrameCompleteCallback WsfSimulationObserver::FrameComplete |
The frame has completed.
- Parameters
-
aSimTime The current simulation time.
◆ FramePlatformsUpdated
| WsfObserver::FramePlatformsUpdatedCallback WsfSimulationObserver::FramePlatformsUpdated |
The platforms updates have completed in the frame.
- Parameters
-
aSimTime The current simulation time.
◆ FrameStarting
| WsfObserver::FrameStartingCallback WsfSimulationObserver::FrameStarting |
The frame is starting execution.
- Parameters
-
aSimTime The current simulation time.
◆ Initialize
| WsfObserver::InitializeCallback WsfSimulationObserver::Initialize |
Initialize the simulation observer.
This is invoked by WsfSimulation::Initialize(). Simulation observers are initialized prior to initializing any platforms. If a simulation has multiple observers then the order in which they are initialized is undefined.
- Returns
- 'true' if the observer was able to initialize successfully or 'false' if not.
◆ RequestTimeAdvance
| WsfObserver::RequestTimeAdvanceCallback WsfSimulationObserver::RequestTimeAdvance |
Request time advance in a scaled-and-stepped frame-step dis simulation
- Parameters
-
aSimTime The current simulation time. aMaxRate The max rate we believe we can proceed at. aTimeStep The amount of time we'd like to simulate in the next step.
◆ SimulationClockRateChange
| WsfObserver::SimulationClockRateChangeCallback WsfSimulationObserver::SimulationClockRateChange |
The simulation is starting execution.
◆ SimulationComplete
| WsfObserver::SimulationCompleteCallback WsfSimulationObserver::SimulationComplete |
The simulation has completed.
This is called just before all the platforms that existed at the time of completion are removed. The simulation event queue has been purge and no further events will be dispatched.
- Parameters
-
aSimTime The ending simulation time.
◆ SimulationInitializing
| WsfObserver::SimulationInitializingCallback WsfSimulationObserver::SimulationInitializing |
The simulation is initializing.
◆ SimulationPausing
| WsfObserver::SimulationPausingCallback WsfSimulationObserver::SimulationPausing |
The simulation is starting execution.
◆ SimulationPendingStart
| WsfObserver::SimulationPendingStartCallback WsfSimulationObserver::SimulationPendingStart |
The simulation is pending start (i.e. simulation initialization is complete).
◆ SimulationResuming
| WsfObserver::SimulationResumingCallback WsfSimulationObserver::SimulationResuming |
The simulation is starting execution.
◆ SimulationStarting
| WsfObserver::SimulationStartingCallback WsfSimulationObserver::SimulationStarting |
The simulation is starting execution.
◆ SimulationTimeBehind
| WsfObserver::SimulationTimeBehindCallback WsfSimulationObserver::SimulationTimeBehind |
For real-time simulations, notifies subscribers if the simulation clock is behind real-time.
- Parameters
-
aTimeBehind The amount of time the simulation clock is behind the real-time clock.
The documentation for this struct was generated from the following file: