IGSTK
Public Types | Public Member Functions | Protected Member Functions | List of all members
igstk::StateMachineInput< T > Class Template Reference

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

#include <igstkStateMachineInput.h>

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

Public Types

typedef StateMachineInput Self
typedef Token Superclass
- Public Types inherited from igstk::Token
typedef unsigned long IdentifierType
 Type used to represent the codes of the inputs.

Public Member Functions

 StateMachineInput ()
 Constructor.
virtual ~StateMachineInput ()
 Destructor.
- Public Member Functions inherited from igstk::Token
 Token ()
 Constructor.
virtual ~Token ()
 Destructor.
virtual IdentifierType GetIdentifier ()
 Returns the unique identifier of the current instance.
void Print (std::ostream &os, itk::Indent indent) const
 Method for printing out the member variables of this object to a ostream.

Protected Member Functions

virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
- Protected Member Functions inherited from igstk::Token
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream.

Detailed Description

template<class T>
class igstk::StateMachineInput< T >

Generic implementation of the Input in a State Machine model.

This class provides a generic representation of a Input. 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 Input 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
StateMachineState
Token
StateMachineAction

Definition at line 51 of file igstkStateMachineInput.h.

Member Typedef Documentation

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

Definition at line 56 of file igstkStateMachineInput.h.

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

Definition at line 57 of file igstkStateMachineInput.h.

Constructor & Destructor Documentation

template<class T >
igstk::StateMachineInput< T >::StateMachineInput ( )
inline

Constructor.

It initializes all the member variables

Definition at line 60 of file igstkStateMachineInput.h.

template<class T >
virtual igstk::StateMachineInput< T >::~StateMachineInput ( )
inlinevirtual

Destructor.

Definition at line 63 of file igstkStateMachineInput.h.

Member Function Documentation

template<class T >
virtual void igstk::StateMachineInput< T >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineprotectedvirtual

Print the object information in a stream.

Definition at line 68 of file igstkStateMachineInput.h.


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