WsfArticulatedPartEvent Class Reference
#include <WsfArticulatedPartEvent.hpp>
Inheritance diagram for WsfArticulatedPartEvent:
Collaboration diagram for WsfArticulatedPartEvent:
Public Types | |
| enum | EventType { cUPDATE_ARTICULATION } |
| Public Types inherited from WsfEvent | |
| enum | EventDisposition { cDELETE , cRESCHEDULE } |
Public Member Functions | |
| WsfArticulatedPartEvent (double aSimTime, EventType aEventType, WsfArticulatedPart *aArticulatedPartPtr) | |
| 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. | |
Detailed Description
An event to process articulated part updates.
This event is queued by WsfEventStepSimulation (or anything that wants to behave like it).
Member Enumeration Documentation
◆ EventType
Constructor & Destructor Documentation
◆ WsfArticulatedPartEvent()
| WsfArticulatedPartEvent::WsfArticulatedPartEvent | ( | double | aSimTime, |
| EventType | aEventType, | ||
| WsfArticulatedPart * | aArticulatedPartPtr ) |
References platformPtr, 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, WsfEvent::cRESCHEDULE, cUPDATE_ARTICULATION, WsfSimulation::GetPlatformByIndex(), WsfEvent::GetSimulation(), WsfEvent::GetTime(), platformPtr, WsfEvent::SetTime(), and simTime.
The documentation for this class was generated from the following files: