IGSTK
Public Types | Public Member Functions | Protected Member Functions
igstk::StateMachineState< T > Class Template Reference

Generic implementation of the State in a State Machine model. More...

#include <igstkStateMachineState.h>

Inheritance diagram for igstk::StateMachineState< T >:
Inheritance graph
[legend]
Collaboration diagram for igstk::StateMachineState< T >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef StateMachineState Self
typedef Token Superclass

Public Member Functions

 StateMachineState ()
 Constructor.
virtual ~StateMachineState ()
 Destructor.

Protected Member Functions

virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.

Detailed Description

template<class T>
class igstk::StateMachineState< T >

Generic implementation of the State in a State Machine model.

This class provides a generic representation of a State. It is intended to be derived in order to implement specific states an to enforce the following characteristics on the behavior of the State Machine:

These characteristics are enforced by taking advantage of natural checks performed by the compiler. In particular, the uniqueness of the State name will be enforced by making every state to be an C++ variable. The compiler will produce errors as a result of any attempt to repeat the name of a variable inside the same namespace.

See also:
StateMachine
StateMachineInput
Token
StateMachineAction

Definition at line 54 of file igstkStateMachineState.h.


Member Typedef Documentation

template<class T >
typedef StateMachineState igstk::StateMachineState< T >::Self

Definition at line 58 of file igstkStateMachineState.h.

template<class T >
typedef Token igstk::StateMachineState< T >::Superclass

Definition at line 59 of file igstkStateMachineState.h.


Constructor & Destructor Documentation

template<class T >
igstk::StateMachineState< T >::StateMachineState ( ) [inline]

Constructor.

It initializes all the member variables

Definition at line 62 of file igstkStateMachineState.h.

template<class T >
virtual igstk::StateMachineState< T >::~StateMachineState ( ) [inline, virtual]

Destructor.

Definition at line 65 of file igstkStateMachineState.h.


Member Function Documentation

template<class T >
virtual void igstk::StateMachineState< T >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [inline, protected, virtual]

Print the object information in a stream.

Definition at line 70 of file igstkStateMachineState.h.


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