Public Member Functions | Private Attributes | List of all members
smclib.statemap.FSMContext Class Reference
Inheritance diagram for smclib.statemap.FSMContext:
Inheritance graph

Public Member Functions

def __init__ (self, state)
def clearState (self)
def emptyStateStack (self)
def getDebugFlag (self)
def getDebugStream (self)
def getPreviousState (self)
def getState (self)
def getStateStackDepth (self)
def getTransition (self)
def isInTransition (self)
def isStateStackEmpty (self)
def popState (self)
def pushState (self, state)
def setDebugFlag (self, flag)
def setDebugStream (self, stream)
def setState (self, state)

Private Attributes


Detailed Description

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.

Definition at line 68 of file

Constructor & Destructor Documentation

def smclib.statemap.FSMContext.__init__ (   self,

Definition at line 77 of file

Member Function Documentation

def smclib.statemap.FSMContext.clearState (   self)
Clears the current state.

Definition at line 121 of file

def smclib.statemap.FSMContext.emptyStateStack (   self)
Remove all states from the state stack.

Definition at line 169 of file

def smclib.statemap.FSMContext.getDebugFlag (   self)
Returns the debug flag's current setting.

Definition at line 85 of file

def smclib.statemap.FSMContext.getDebugStream (   self)
Returns the stream to which debug output is written.

Definition at line 94 of file

def smclib.statemap.FSMContext.getPreviousState (   self)
Returns the state which a transition left.
May be None

Definition at line 126 of file

def smclib.statemap.FSMContext.getState (   self)
Returns the current state.

Definition at line 102 of file

def smclib.statemap.FSMContext.getStateStackDepth (   self)
Returns the state stack's depth.

Definition at line 143 of file

def smclib.statemap.FSMContext.getTransition (   self)
Returns the current transition's name.
Used only for debugging purposes.

Definition at line 116 of file

def smclib.statemap.FSMContext.isInTransition (   self)
Is this state machine already inside a transition?
True if state is undefined.

Definition at line 108 of file

def smclib.statemap.FSMContext.isStateStackEmpty (   self)
Returns True if the state stack is empty and False otherwise.

Definition at line 139 of file

def smclib.statemap.FSMContext.popState (   self)
Make the state on top of the state stack the current state.

Definition at line 158 of file

def smclib.statemap.FSMContext.pushState (   self,
Push the current state on top of the state stack
and make the specified state the current state.

Definition at line 147 of file

def smclib.statemap.FSMContext.setDebugFlag (   self,
Sets the debug flag.
A true value means debugging is on and false means off.

Definition at line 89 of file

def smclib.statemap.FSMContext.setDebugStream (   self,
Sets the debug output stream.

Definition at line 98 of file

def smclib.statemap.FSMContext.setState (   self,
Sets the current state to the specified state.

Definition at line 131 of file

Member Data Documentation


Definition at line 82 of file


Definition at line 83 of file


Definition at line 79 of file


Definition at line 78 of file


Definition at line 80 of file


Definition at line 81 of file

The documentation for this class was generated from the following file:

Author(s): Various
autogenerated on Wed Mar 20 2019 07:55:33