Components/Libraries/XF/FreeRTOS/Event

Event

This class describe events that are used by state machines to execute their next state

Member Attributes

eEventType _type : the basical type of the event

ID_SIZE _id : the event's ID

timeSize _delay : the time in ms befor the event must be sent to the state machine

Thread* _pDstThread : the thread where is living the destinated state machine

IStateMachine* _pDstStateMachine : the destinated state machine

PRIORITY_SIZE _priority : the priority of the event

static ID_SIZE _nextFreeID : the next free ID

bool _isActive : indicate if the event is active

const bool _isStatic : indicate that the event has been created statically and must not be delete

Member Functions Documentation

Event* createEvent(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, timeSize oDelay, PRIORITY_SIZE oPriority) [static]

Description

This function create an event and return a pointer to it. The ID of the Event is automatically set.

Event* createStaticEvent(ID_SIZE oID, eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, timeSize oDelay, PRIORITY_SIZE oPriority) [static]

Description

This function create a static event and return a pointer to it. You need to set manually the ID of a static event.

void deleteEvent(Event* opEv) [static]

Description

This function delete the event

void setDelay(timeSize oDelay)

Description

Set the delay of the event

void setEventType(eEventType oNewType)

Description

Set the basic type of the event

void setPriority(PRIORITY_SIZE oNewPriority)

Description

Set the priority of the event

void setDstStateMachine(IStateMachine* opDstStateMachine)

Description

Set the destinated state machine

void setDstThread(Thread* opDstThread)

Description

Set the thread where is living the destinated state machine (only used by events with delay