WsfScriptContext::ExecuteTimedEventScript Class Reference
An event to execute a script at a specified time. More...
#include <WsfScriptContext.hpp>
Inheritance diagram for WsfScriptContext::ExecuteTimedEventScript:
Collaboration diagram for WsfScriptContext::ExecuteTimedEventScript:
Public Member Functions | |
| ExecuteTimedEventScript () | |
| ExecuteTimedEventScript (double aSimTime, double aTimeInterval, WsfPlatform *aPlatformPtr, WsfScriptContext *aContextPtr, WsfStringId aScriptName) | |
| 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 event to execute a script at a specified time.
Constructor & Destructor Documentation
◆ ExecuteTimedEventScript() [1/2]
|
inline |
◆ ExecuteTimedEventScript() [2/2]
| WsfScriptContext::ExecuteTimedEventScript::ExecuteTimedEventScript | ( | double | aSimTime, |
| double | aTimeInterval, | ||
| WsfPlatform * | aPlatformPtr, | ||
| WsfScriptContext * | aContextPtr, | ||
| WsfStringId | aScriptName ) |
References WsfPlatform::GetIndex(), WsfEvent::WsfEvent(), and WsfScriptContext::WsfScriptContext().
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, WsfEvent::cRESCHEDULE, WsfScriptContext::GetSimulation(), WsfEvent::GetTime(), WsfEvent::SetTime(), and simTime.
The documentation for this class was generated from the following files: