Contents
- 1 Event
- 2 Member Attributes
- 3 Member Functions Documentation
- 3.1 Event* createEvent(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, timeSize oDelay, PRIORITY_SIZE oPriority) [static]
- 3.2 Event* createStaticEvent(ID_SIZE oID, eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, timeSize oDelay, PRIORITY_SIZE oPriority) [static]
- 3.3 void deleteEvent(Event* opEv) [static]
- 3.4 void setDelay(timeSize oDelay)
- 3.5 void setEventType(eEventType oNewType)
- 3.6 void setPriority(PRIORITY_SIZE oNewPriority)
- 3.7 void setDstStateMachine(IStateMachine* opDstStateMachine)
- 3.8 void setDstThread(Thread* opDstThread)
- 3.9 eEventType getEventType()
- 3.10 ID_SIZE getID()
- 3.11 timeSize getDelay()
- 3.12 PRIORITY_SIZE getPriority()
- 3.13 IStateMachine* getDstStateMachine()
- 3.14 Thread* getDstThread()
- 3.15 ID_SIZE getFreeID() [static]
- 3.16 bool isActive()
- 3.17 bool isStatic()
- 3.18 void cancel()
- 3.19 Event(eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)
- 3.20 Event(ID_SIZE oID, eEventType oType, IStateMachine* opDstStateMachine, Thread* opDstThread, bool oIsStatic, timeSize oDelay, PRIORITY_SIZE oPriority)
- 3.21 ~Event() [virtual]
|
|
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]
