Class Statemap::FSMContext
In: sipper/lib/smc/statemap.rb
Parent: Object

The user can derive FSM contexts from this class and interface to them with the methods of this class.

The finite state machine needs to be initialized to the starting state of the FSM. This must be done manually in the constructor of the derived class.

Methods

clearState   emptyStateStack   getDebugFlag   getDebugStream   getPreviousState   getStateStackDepth   getTransition   isInTransition   isStateStackEmpty   new   popState   pushState   setDebugFlag   setDebugStream   setState  

Public Class methods

Public Instance methods

clearState()

Clears the current state.

emptyStateStack()

Remove all states from the state stack.

getDebugFlag()

Returns the debug flag‘s current setting.

getDebugStream()

Returns the stream to which debug output is written.

getPreviousState()

Returns the state which a transition left.

May be nil.

getStateStackDepth()

Returns the state stack‘s depth.

getTransition()

Returns the current transition‘s name.

Used only for debugging purposes.

isInTransition()

Is this state machine already inside a transition?

True if state is undefined.

isStateStackEmpty()

Returns true if the state stack is empty and false otherwise.

popState()

Make the state on top of the state stack the current state.

pushState(state)

Push the current state on top of the state stack and make the specified state the current state.

setDebugFlag(flag)

Sets the debug flag.

A true value means debugging is on and false means off.

setDebugStream(stream)

Sets the debug output stream.

setState(state)

Sets the current state to the specified state.

[Validate]