Components/Libraries/XF/FreeRTOS/StateMachineDirectory
From UIT
(Difference between revisions)
Sara.chalokh (Talk | contribs) (Created page with "{{TOC right}} = StateMachineDirectory = This class contain a list of all state machine and can be consulted by all state machine for the inter-state machine communication Imp...") |
Sara.chalokh (Talk | contribs) (→Description) |
||
(2 intermediate revisions by one user not shown) | |||
Line 17: | Line 17: | ||
=== Description === | === Description === | ||
oSmToAdd : a pointer to the state machine to add | oSmToAdd : a pointer to the state machine to add | ||
+ | === Parameters === | ||
+ | StateMachine* '''oSmToAdd''' : a pointer to the state machine to add | ||
+ | |||
== bool removeStateMachine(StateMachine* oSmToAdd) == | == bool removeStateMachine(StateMachine* oSmToAdd) == | ||
=== Description === | === Description === | ||
− | oSmToAdd : a pointer to the state machine to remove | + | Remove a state machine from the list (this method is called in the destructor of state machine) |
+ | |||
+ | === Parameters === | ||
+ | StateMachine* '''oSmToAdd''' : a pointer to the state machine to remove | ||
+ | |||
== StateMachineDirectory() == | == StateMachineDirectory() == | ||
=== Description === | === Description === | ||
Return a constant pointer to the state machine list | Return a constant pointer to the state machine list |
Latest revision as of 20:39, 24 August 2017
|
StateMachineDirectory
This class contain a list of all state machine and can be consulted by all state machine for the inter-state machine communication
Implements the singleton pattern
Member Attributes
StateMachineDirectory* _pInstance : the only one instance of this class list<StateMachine*>* _smList : the list of all state machine
Member Functions Documentation
StateMachineDirectory* getInstance() [static]
Description
Return the instance of the state machine directory
~StateMachineDirectory()
Description
The destructor of the StateMachineDirectory
void addStateMachine(StateMachine* oSmToAdd)
Description
oSmToAdd : a pointer to the state machine to add
Parameters
StateMachine* oSmToAdd : a pointer to the state machine to add
bool removeStateMachine(StateMachine* oSmToAdd)
Description
Remove a state machine from the list (this method is called in the destructor of state machine)
Parameters
StateMachine* oSmToAdd : a pointer to the state machine to remove
StateMachineDirectory()
Description
Return a constant pointer to the state machine list