WsfSimulation::AddPlatformEvent Class Reference
An internal event scheduled to add a platform at the specified time. More...
#include <WsfSimulation.hpp>
Inheritance diagram for WsfSimulation::AddPlatformEvent:
Collaboration diagram for WsfSimulation::AddPlatformEvent:
Public Member Functions | |
| AddPlatformEvent (double aSimTime, WsfPlatform *aPlatformPtr) | |
| ~AddPlatformEvent () override | |
| EventDisposition | Execute () override |
| Public Member Functions inherited from WsfEvent | |
| WsfEvent ()=default | |
| WsfEvent (double aSimTime, int aPriority=0) | |
| WsfEvent (const WsfEvent &aSrc)=delete | |
| Copy constructor and copy assignment deleted to prevent copying. | |
| WsfEvent & | operator= (const WsfEvent &aRhs)=delete |
| virtual | ~WsfEvent ()=default |
| double | GetTime () const |
| int | GetPriority () const |
| bool | ShouldExecute () const |
| void | SetTime (double aSimTime) |
| void | SetPriority (int aPriority) |
| void | SetShouldExecute (bool aExecute) |
| WsfSimulation * | GetSimulation () const |
| void | AddedToEventQueue (WsfSimulation &aSimulation) |
| Called when the event is added to the event queue of the specified simulation. | |
Additional Inherited Members | |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Detailed Description
An internal event scheduled to add a platform at the specified time.
Constructor & Destructor Documentation
◆ AddPlatformEvent()
| WsfSimulation::AddPlatformEvent::AddPlatformEvent | ( | double | aSimTime, |
| WsfPlatform * | aPlatformPtr ) |
References WsfEvent::WsfEvent().
◆ ~AddPlatformEvent()
|
override |
Member Function Documentation
◆ Execute()
|
overridevirtual |
Execute the specified event.
- Returns
- The disposition of the event. This indicates to the event manager what should be done with the event. If cRESCHEDULE then Execute should have called SetTime to set the time for which the event manager should reschedule the event.
Implements WsfEvent.
References WsfSimulation::AddPlatform(), WsfEvent::cDELETE, and WsfEvent::GetSimulation().
The documentation for this class was generated from the following files: