#include <WsfXIO_SimTimeService.hpp>
Public Member Functions | |
| UpdateEvent (WsfXIO_SimTimeService *aServicePtr, WsfXIO_SubscriptionId aSubscriptionId, double aInterval, bool aIsAdjusted, bool aIsWallClockEvent) | |
| UpdateEvent (const UpdateEvent &aSrc) | |
| void | Disable () |
| 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. | |
Public Attributes | |
| bool | mIsActive |
| bool | mIsAdjusted |
| bool | mIsWallClockEvent |
| double | mInterval |
| WsfXIO_SimTimeService * | mServicePtr |
| WsfXIO_SubscriptionId | mSubscriptionId |
| double | mRate |
Additional Inherited Members | |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Constructor & Destructor Documentation
◆ UpdateEvent() [1/2]
| WsfXIO_SimTimeService::UpdateEvent::UpdateEvent | ( | WsfXIO_SimTimeService * | aServicePtr, |
| WsfXIO_SubscriptionId | aSubscriptionId, | ||
| double | aInterval, | ||
| bool | aIsAdjusted, | ||
| bool | aIsWallClockEvent ) |
◆ UpdateEvent() [2/2]
| WsfXIO_SimTimeService::UpdateEvent::UpdateEvent | ( | const UpdateEvent & | aSrc | ) |
References mInterval, mIsActive, mIsAdjusted, mIsWallClockEvent, mRate, mServicePtr, mSubscriptionId, and UpdateEvent().
Member Function Documentation
◆ Disable()
|
inline |
References mIsActive.
Referenced by WsfXIO_SimTimeService::HandleClockRateChange().
◆ 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, WsfEvent::cRESCHEDULE, WsfEvent::GetSimulation(), WsfEvent::GetTime(), mInterval, mIsActive, mIsWallClockEvent, mRate, mServicePtr, mSubscriptionId, and WsfEvent::SetTime().
Member Data Documentation
◆ mInterval
| double WsfXIO_SimTimeService::UpdateEvent::mInterval |
Referenced by Execute(), WsfXIO_SimTimeService::HandleClockRateChange(), UpdateEvent(), and UpdateEvent().
◆ mIsActive
| bool WsfXIO_SimTimeService::UpdateEvent::mIsActive |
Referenced by Disable(), Execute(), UpdateEvent(), and UpdateEvent().
◆ mIsAdjusted
| bool WsfXIO_SimTimeService::UpdateEvent::mIsAdjusted |
Referenced by WsfXIO_SimTimeService::HandleClockRateChange(), UpdateEvent(), and UpdateEvent().
◆ mIsWallClockEvent
| bool WsfXIO_SimTimeService::UpdateEvent::mIsWallClockEvent |
Referenced by Execute(), UpdateEvent(), and UpdateEvent().
◆ mRate
| double WsfXIO_SimTimeService::UpdateEvent::mRate |
Referenced by Execute(), WsfXIO_SimTimeService::HandleClockRateChange(), UpdateEvent(), and UpdateEvent().
◆ mServicePtr
| WsfXIO_SimTimeService* WsfXIO_SimTimeService::UpdateEvent::mServicePtr |
Referenced by Execute(), UpdateEvent(), and UpdateEvent().
◆ mSubscriptionId
| WsfXIO_SubscriptionId WsfXIO_SimTimeService::UpdateEvent::mSubscriptionId |
Referenced by Execute(), UpdateEvent(), and UpdateEvent().
The documentation for this class was generated from the following files: