Components/Libraries/XF/FreeRTOS/StateMachine

(Difference between revisions)
Jump to: navigation, search
(Parameters)
(~StateMachine() [virtual])
Line 17: Line 17:
 
== ~StateMachine() [virtual] ==
 
== ~StateMachine() [virtual] ==
 
=== Description ===
 
=== Description ===
 +
The destructor of the StateMachine
 +
 
== Thread* getThread() ==
 
== Thread* getThread() ==
 
=== Description ===
 
=== Description ===

Revision as of 13:50, 21 August 2017

Contents

StateMachine

This class is a basic state machine whose users state machine must inherits if they would work with XFOS

Member Attributes

Member Functions Documentation

StateMachine(string oName, Thread* opThread)

Description

The constructor of the StateMachine. It automatically set the actual state to Initial.

If useStateMachineDirectory is define, it add the state machine to the directory

Parameters

string oName : the name of the state machine

Thread* opThread : a pointer to the thread where the state machine will live

~StateMachine() [virtual]

Description

The destructor of the StateMachine

Thread* getThread()

Description

void startProcessing() [virtual]

Description

void pushEvent(Event* opEv)

Description

Parameters

eEventStatus process(Event *opEv)

Description

Parameters

void cancelEvent(Event* opEv) [virtual]

Description

Parameters

eEventStatus processEvent(Event *opEv) [pure virtual]

Description

Parameters

Personal tools
Namespaces
Variants
Actions
Navigation
Browse
Toolbox