WsfTimeDelayQueue::CompleteRequestEvent Class Reference
An event scheduled to complete the request at the end of its delay time. More...
#include <WsfTimeDelayQueue.hpp>
Inheritance diagram for WsfTimeDelayQueue::CompleteRequestEvent:
Collaboration diagram for WsfTimeDelayQueue::CompleteRequestEvent:
Public Member Functions | |
| CompleteRequestEvent ()=default | |
| CompleteRequestEvent (double aSimTime, Request *aRequestPtr, WsfTimeDelayQueue *aQueuePtr, size_t aServerIndex) | |
| ~CompleteRequestEvent () 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 event scheduled to complete the request at the end of its delay time.
Constructor & Destructor Documentation
◆ CompleteRequestEvent() [1/2]
|
default |
References CompleteRequestEvent(), Execute(), and WsfTimeDelayQueue::WsfTimeDelayQueue().
Referenced by CompleteRequestEvent().
◆ CompleteRequestEvent() [2/2]
| WsfTimeDelayQueue::CompleteRequestEvent::CompleteRequestEvent | ( | double | aSimTime, |
| Request * | aRequestPtr, | ||
| WsfTimeDelayQueue * | aQueuePtr, | ||
| size_t | aServerIndex ) |
◆ ~CompleteRequestEvent()
|
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 WsfEvent::cDELETE, WsfEvent::cRESCHEDULE, WsfTimeDelayQueue::GetSimulation(), WsfEvent::GetTime(), and WsfEvent::SetTime().
Referenced by CompleteRequestEvent().
The documentation for this class was generated from the following files: