ToolUpdateEvent Class Reference
#include <ToolUpdateEvent.hpp>
Inheritance diagram for ToolUpdateEvent:
Collaboration diagram for ToolUpdateEvent:
Public Member Functions | |
| ToolUpdateEvent (double aStartTime, Tool *aToolPtr) | |
| 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 } |
Constructor & Destructor Documentation
◆ ToolUpdateEvent()
| ToolUpdateEvent::ToolUpdateEvent | ( | double | aStartTime, |
| Tool * | aToolPtr ) |
References 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::cRESCHEDULE, WsfEvent::GetTime(), and WsfEvent::SetTime().
The documentation for this class was generated from the following files: