Components/Libraries/XF/FreeRTOS/Event

(Difference between revisions)
Jump to: navigation, search
(Member Attributes)
(Member Attributes)
Line 5: Line 5:
 
= Member Attributes =
 
= Member Attributes =
 
eEventType '''_type''' : the basical type of the event
 
eEventType '''_type''' : the basical type of the event
 +
 
ID_SIZE '''_id''' : the event's ID
 
ID_SIZE '''_id''' : the event's ID
 +
 
timeSize '''_delay''' : the time in ms befor the event must be sent to the state machine
 
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
 
Thread* '''_pDstThread''' : the thread where is living the destinated state machine
 +
 
IStateMachine* '''_pDstStateMachine''' : the destinated state machine
 
IStateMachine* '''_pDstStateMachine''' : the destinated state machine
 +
 
PRIORITY_SIZE '''_priority''' : the priority of the event
 
PRIORITY_SIZE '''_priority''' : the priority of the event
 +
 
static ID_SIZE '''_nextFreeID''' : the next free ID
 
static ID_SIZE '''_nextFreeID''' : the next free ID
 +
 
bool _isActive : indicate if the event is active
 
bool _isActive : indicate if the event is active
 +
 
const bool '''_isStatic''' : indicate that the event has been created statically and must not be delete
 
const bool '''_isStatic''' : indicate that the event has been created statically and must not be delete
  

Revision as of 19:23, 24 August 2017

Contents

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]

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

void deleteEvent(Event* opEv) [static]

void setDelay(timeSize oDelay)

void setEventType(eEventType oNewType)

void setPriority(PRIORITY_SIZE oNewPriority)

void setDstStateMachine(IStateMachine* opDstStateMachine)

void setDstThread(Thread* opDstThread)

eEventType getEventType()

ID_SIZE getID()

timeSize getDelay()

PRIORITY_SIZE getPriority()

IStateMachine* getDstStateMachine()

Thread* getDstThread()

ID_SIZE getFreeID() [static]

bool isActive()

bool isStatic()

void cancel()

Event(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)

Event(ID_SIZE oID, eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)

~Event() [virtual]

Personal tools
Namespaces
Variants
Actions
Navigation
Browse
Toolbox