Components/Libraries/XF/FreeRTOS/Event
(Difference between revisions)
Sara.chalokh (Talk | contribs) (→Event* createEvent(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, timeSize oDelay, PRIORITY_SIZE oPriority) [static]) |
Sara.chalokh (Talk | contribs) (→Member Functions Documentation) |
||
| Line 26: | Line 26: | ||
== Event* createStaticEvent(ID_SIZE oID, 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] == | ||
| + | === Description === | ||
== void deleteEvent(Event* opEv) [static] == | == void deleteEvent(Event* opEv) [static] == | ||
| + | === Description === | ||
== void setDelay(timeSize oDelay) == | == void setDelay(timeSize oDelay) == | ||
| + | === Description === | ||
== void setEventType(eEventType oNewType) == | == void setEventType(eEventType oNewType) == | ||
| + | === Description === | ||
== void setPriority(PRIORITY_SIZE oNewPriority) == | == void setPriority(PRIORITY_SIZE oNewPriority) == | ||
| + | === Description === | ||
== void setDstStateMachine(IStateMachine* opDstStateMachine) == | == void setDstStateMachine(IStateMachine* opDstStateMachine) == | ||
| + | === Description === | ||
== void setDstThread(Thread* opDstThread) == | == void setDstThread(Thread* opDstThread) == | ||
| + | === Description === | ||
== eEventType getEventType() == | == eEventType getEventType() == | ||
| + | === Description === | ||
== ID_SIZE getID() == | == ID_SIZE getID() == | ||
| + | === Description === | ||
== timeSize getDelay() == | == timeSize getDelay() == | ||
| + | === Description === | ||
== PRIORITY_SIZE getPriority() == | == PRIORITY_SIZE getPriority() == | ||
| + | === Description === | ||
== IStateMachine* getDstStateMachine() == | == IStateMachine* getDstStateMachine() == | ||
| + | === Description === | ||
== Thread* getDstThread() == | == Thread* getDstThread() == | ||
| + | === Description === | ||
== ID_SIZE getFreeID() [static] == | == ID_SIZE getFreeID() [static] == | ||
| + | === Description === | ||
== bool isActive() == | == bool isActive() == | ||
| + | === Description === | ||
== bool isStatic() == | == bool isStatic() == | ||
| + | === Description === | ||
== void cancel() == | == void cancel() == | ||
| + | === Description === | ||
== 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 === | ||
== 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 === | ||
== ~Event() [virtual] == | == ~Event() [virtual] == | ||
| + | === Description === | ||
Revision as of 19:25, 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
