EventHandler< T > Class Template Reference

Public Types
enum	execState_e {   NOOP , INITIALIZE , EXECUTE , TERMINATE ,   DONE }
	enumerations for the execution state More...
enum	retVal_e { SUCCESS , RESET , INPROGRESS , SHUTDOWN }
	enumerations for the return state

Public Member Functions
virtual retVal_e	Initialize (T *state)
	perform all initialization activities for a specific task More...
virtual retVal_e	Execute (T *state)
	perform the core activity More...
virtual retVal_e	Terminate (T *state)
	perform termination activities More...
bool	RunEvent (T *state)
	Run this event. More...
void	ExecuteHandler (std::shared_ptr< EventHandler< T > > hdl, std::string eventName, float priorityNew=0)
	Spawn another handler. More...

Public Attributes
std::string	eventName
	event name
execState_e	execState
	current execution state for this handler
std::list< std::shared_ptr< EventHandler< T > > >	children
	list of child handlers
float	priority
	current execution priority
float	defaultPriority
	user defined priority for this handler

Member Enumeration Documentation

execState_e

template<class T >

enum EventHandler::execState_e

Member Function Documentation

Execute()

template<class T >

virtual retVal_e EventHandler< T >::Execute ( T *  state )

inlinevirtual

Parameters

state

Returns

retVal_e

Reimplemented in EngageNominalPlan, TakeoffPhaseHandler, Vector2Mission, ReturnToMission, ReturnToNextFeasibleWP, LandPhaseHandler, TrafficConflictHandler, MergingHandler, RequestDitchSite, ProceedToDitchSite, ProceedFromTODtoLand, and IcarousReturnToLaunch.

ExecuteHandler()

template<class T >

void EventHandler< T >::ExecuteHandler	(	std::shared_ptr< EventHandler< T > >	hdl,
		std::string	eventName,
		float	priorityNew = 0
	)

Parameters

hdl	pointer to the other handler
eventName
priorityNew

Initialize()

template<class T >

virtual retVal_e EventHandler< T >::Initialize ( T *  state )

inlinevirtual

Parameters

state

Returns

retVal_e

Reimplemented in TakeoffPhaseHandler, Vector2Mission, ReturnToMission, ReturnToNextFeasibleWP, LandPhaseHandler, TrafficConflictHandler, MergingHandler, RequestDitchSite, ProceedToDitchSite, ProceedFromTODtoLand, IcarousReturnToLaunch, and CommandReturnToLaunch.

RunEvent()

template<class T >

bool EventHandler< T >::RunEvent

(

T *

state

)

Parameters

state

Returns

true

false

Terminate()

template<class T >

virtual retVal_e EventHandler< T >::Terminate ( T *  state )

inlinevirtual

Parameters

state

Returns

retVal_e

Reimplemented in TakeoffPhaseHandler, Vector2Mission, TrafficConflictHandler, MergingHandler, ProceedFromTODtoLand, IcarousReturnToLaunch, and FenceConflictHandler.

---

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

• Modules/Core/EventManager/EventHandler.hpp