Components/Libraries/XF/FreeRTOS/Event
Sara.chalokh (Talk | contribs) (→Description) |
Sara.chalokh (Talk | contribs) (→Member Functions Documentation) |
||
Line 69: | Line 69: | ||
== PRIORITY_SIZE getPriority() == | == PRIORITY_SIZE getPriority() == | ||
=== Description === | === Description === | ||
+ | Get the priority of the event | ||
+ | |||
== IStateMachine* getDstStateMachine() == | == IStateMachine* getDstStateMachine() == | ||
=== Description === | === Description === | ||
+ | Returns a pointer to the destinated state machine | ||
+ | |||
== Thread* getDstThread() == | == Thread* getDstThread() == | ||
=== Description === | === Description === | ||
+ | Returns a pointer to the destinated thread | ||
+ | |||
== ID_SIZE getFreeID() [static] == | == ID_SIZE getFreeID() [static] == | ||
=== Description === | === Description === | ||
+ | This function is used to set an auto free ID | ||
+ | |||
== bool isActive() == | == bool isActive() == | ||
=== Description === | === Description === | ||
+ | Indicate if the event is active | ||
+ | |||
== bool isStatic() == | == bool isStatic() == | ||
=== Description === | === Description === | ||
+ | Indicate if the event is static | ||
+ | |||
== void cancel() == | == void cancel() == | ||
=== Description === | === Description === | ||
+ | Cancel the event (set it in the inactive state) | ||
+ | |||
== Event(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority) == | == Event(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority) == | ||
=== Description === | === Description === | ||
+ | The constructor of the Event | ||
+ | |||
== Event(ID_SIZE oID, 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) == | ||
=== Description === | === Description === | ||
+ | The constructor of the Event | ||
+ | |||
== ~Event() [virtual] == | == ~Event() [virtual] == | ||
=== Description === | === Description === | ||
+ | The destructor of the Event. It does anything because pointers must not be destroyed |
Revision as of 19:35, 24 August 2017
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
eEventType getEventType()
Description
Returns the basic type of the event. This method does not modify attributes
ID_SIZE getID()
Description
Returns the ID of the event
timeSize getDelay()
Description
Returns the time in ms before the event must be sent to the state machine
PRIORITY_SIZE getPriority()
Description
Get the priority of the event
IStateMachine* getDstStateMachine()
Description
Returns a pointer to the destinated state machine
Thread* getDstThread()
Description
Returns a pointer to the destinated thread
ID_SIZE getFreeID() [static]
Description
This function is used to set an auto free ID
bool isActive()
Description
Indicate if the event is active
bool isStatic()
Description
Indicate if the event is static
void cancel()
Description
Cancel the event (set it in the inactive state)
Event(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)
Description
The constructor of the Event
Event(ID_SIZE oID, eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)
Description
The constructor of the Event
~Event() [virtual]
Description
The destructor of the Event. It does anything because pointers must not be destroyed