WsfTaskManager::EventBase Class Reference

#include <WsfTaskManager.hpp>

Inheritance diagram for WsfTaskManager::EventBase:

Collaboration diagram for WsfTaskManager::EventBase:

Public Member Functions
	EventBase (double aSimTime, WsfTaskManager *aManagerPtr)
EventDisposition	Execute () override
virtual EventDisposition	ExecuteEvent (WsfTaskManager *aTaskManagerPtr)=0
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

Base class for task manager events. It ensures the platform is still alive prior to calling ExecuteEvent()

Constructor & Destructor Documentation

EventBase()

WsfTaskManager::EventBase::EventBase	(	double	aSimTime,
		WsfTaskManager *	aManagerPtr )

References WsfPlatformPart::GetPlatform(), WsfEvent::WsfEvent(), and WsfTaskManager::WsfTaskManager().

Referenced by WsfTaskManager::TaskCompleteEvent::TaskCompleteEvent(), and WsfTaskManager::TrackUpdateEvent::TrackUpdateEvent().

Member Function Documentation

Execute()

WsfEvent::EventDisposition WsfTaskManager::EventBase::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, ExecuteEvent(), and WsfPlatformPart::GetSimulation().

ExecuteEvent()

virtual EventDisposition WsfTaskManager::EventBase::ExecuteEvent ( WsfTaskManager * aTaskManagerPtr )

pure virtual

Implemented in WsfTaskManager::TaskCompleteEvent, and WsfTaskManager::TrackUpdateEvent.

References WsfTaskManager::WsfTaskManager().

Referenced by Execute().

---

The documentation for this class was generated from the following files:

• WsfTaskManager.hpp
• WsfTaskManager.cpp