WsfEclipseReport::EclipseEvent Class Reference
#include <WsfEclipseReport.hpp>
Inheritance diagram for WsfEclipseReport::EclipseEvent:
Collaboration diagram for WsfEclipseReport::EclipseEvent:
Public Types | |
| enum | Type { cENTRY , cEXIT , cEVALUATE } |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Public Member Functions | |
| EclipseEvent (Type aType, size_t aId, WsfEclipseReport &aReport, WsfSpaceMoverBase *aSpaceMoverPtr) | |
| void | SetType (Type aType) |
| WsfEvent::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. | |
Member Enumeration Documentation
◆ Type
Constructor & Destructor Documentation
◆ EclipseEvent()
| WsfEclipseReport::EclipseEvent::EclipseEvent | ( | Type | aType, |
| size_t | aId, | ||
| WsfEclipseReport & | aReport, | ||
| WsfSpaceMoverBase * | aSpaceMoverPtr ) |
References WsfEclipseReport::WsfEclipseReport(), and WsfEvent::WsfEvent().
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 WsfEvent::cDELETE, cENTRY, cEVALUATE, cEXIT, WsfEvent::cRESCHEDULE, WsfSimulationExtension::GetSimulation(), WsfEvent::GetTime(), WsfEclipseReportData::EclipseInterval::mStart, and WsfEvent::SetTime().
◆ SetType()
|
inline |
The documentation for this class was generated from the following files: