FSM Namespace Reference

All the FSMs related classes are defined here. FSM help defines directives are located outside of the namespace. More...

Classes
class	SStateMachineException
	Exception definition for the state machine template class. More...
class	SEmptyFunctor
	Predefined strategy for the template which bounds functions to states. Strategy supposes no entry, no exit functions calls. More...
class	SOnEnterFunctor
	Predefined strategy for the template which bounds functions to states. Strategy supposes entry functions calls only. More...
class	SOnExitFunctor
	Predefined strategy for the template which bounds functions to states. Strategy supposes exit functions calls only. More...
class	SOnMoveFunctor
	Predefined strategy for the template which bounds functions to states. Strategy supposes both entry and exit functions calls. More...
class	SThrowStrategy
	Predefined strategy for both versions of the template. Strategy supposes throwing exception in case of the unknown event. More...
class	SIgnoreStrategy
	Predefined strategy for both versions of the template. Strategy supposes ignoging the unknown event. More...
class	SStateMachine
	Finite state machine template which bounds functions to the states. More...
class	StateBase
	Base class for the states to allow transition function specification. More...
class	SFuncStateMachine
	Finite state machine template which bounds functions to the transitions. More...
Enumerations
enum	SMachineManipulator { ResetMachine = 0 }
	Machine manipulators are defined here. More...
enum	STransitionManipulator { NONE = 0, EXCEPTION = 1 }
	Transition manipulators are defined here. More...
Functions
template<typename SState, typename SEvent, typename SFunctor, typename SUnknownEventStrategy>
std::ostream &	operator<< (std::ostream &Stream, const SStateMachine< SState, SEvent, SFunctor, SUnknownEventStrategy > &Machine)
	Allow writing the current machine state to an output stream.
template<typename SState, typename SEvent, typename SUnknownEventStrategy>
std::ostream &	operator<< (std::ostream &Stream, const SFuncStateMachine< SState, SEvent, SUnknownEventStrategy > &Machine)
	Allow writing the current machine state to an output stream.

---

Detailed Description

All the FSMs related classes are defined here. FSM help defines directives are located outside of the namespace.

---

Enumeration Type Documentation

enum FSM::SMachineManipulator

Machine manipulators are defined here. Enumerator: ResetMachine  Manipulator resets the machine to the initial state. Definition at line 138 of file fsm.h.

enum FSM::STransitionManipulator

Transition manipulators are defined here. Enumerator: NONE  Used to mark a "nothing to do" transition. EXCEPTION  Used to mark a transition which should generate an exception. Definition at line 145 of file fsm.h.

---

Function Documentation

template<typename SState, typename SEvent, typename SUnknownEventStrategy> std::ostream& FSM::operator<< (  std::ostream &  Stream, const SFuncStateMachine< SState, SEvent, SUnknownEventStrategy > &  Machine )

Allow writing the current machine state to an output stream. Parameters: Stream  Reference to the output stream. Machine  A machine whose state should be outputted. Definition at line 1182 of file fsm.h.

template<typename SState, typename SEvent, typename SFunctor, typename SUnknownEventStrategy> std::ostream& FSM::operator<< (  std::ostream &  Stream, const SStateMachine< SState, SEvent, SFunctor, SUnknownEventStrategy > &  Machine )

Allow writing the current machine state to an output stream. Parameters: Stream  Reference to the output stream. Machine  A machine whose state should be outputted. Returns: A reference to a stream Definition at line 719 of file fsm.h.

---