Components/Libraries/XF/FreeRTOS/IStateMachine
(Difference between revisions)
Sara.chalokh (Talk | contribs) (→pushEvent(Event* opEv) [pusr virtual]) |
Sara.chalokh (Talk | contribs) (→eEventStatus process(Event* opEv) [pure virtual]) |
||
Line 37: | Line 37: | ||
== eEventStatus process(Event* opEv) [pure virtual] == | == eEventStatus process(Event* opEv) [pure virtual] == | ||
=== Description === | === Description === | ||
+ | Process an event (execute the code of the new state). This method must be implemented in subclass | ||
=== Parameters === | === Parameters === | ||
+ | Event* '''opEv''' : a pointer to the event to process | ||
+ | |||
== void cancelEvent(Event* opEv) [pure virtual] == | == void cancelEvent(Event* opEv) [pure virtual] == | ||
=== Description === | === Description === | ||
=== Parameters === | === Parameters === |
Revision as of 13:42, 21 August 2017
IStateMachine
This is an interface that defines all basic methods of a state machine
Member Attributes
Member Functions Documentation
IStateMachine(string oName)
Description
The constructor of the IStateMachine
Parameters
string oName : the name of the state machine
~IStateMachine() [virtual]
Description
The destructor of the IStateMachine.
void setName(string oNewName)
Description
Set the name of the state machine
Parameters
string oNewName : the new name of the state machine
string getName()
Description
Returns the name of the state machine.
void startProcessing() [pure virtual]
Description
Starts the state machine. This method must be implemented in subclass
pushEvent(Event* opEv) [pusr virtual]
Description
Sends an event to start an other state. This method must be implemented in subclass
Parameters
Event* opEv : a pointer to the event to push
eEventStatus process(Event* opEv) [pure virtual]
Description
Process an event (execute the code of the new state). This method must be implemented in subclass
Parameters
Event* opEv : a pointer to the event to process