igstk::Token Class Reference

Class that provides unique identifiers. More...

#include <igstkToken.h>

Inheritance diagram for igstk::Token:

Inheritance graph
[legend]

List of all members.

Public Types

typedef unsigned long IdentifierType
 Type used to represent the codes of the inputs.

Public Member Functions

 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.


Detailed Description

Class that provides unique identifiers.

This class is intended to be used as the base class for the StatMachineState and StateMachineInput classes. It factorizes common behavior regarding the use of the unique identifier and the use of a text description.

See also:
StateMachine

StateMachineInput

StateMachineState

StateMachineAction

Definition at line 43 of file igstkToken.h.


Member Typedef Documentation

typedef unsigned long igstk::Token::IdentifierType

Type used to represent the codes of the inputs.

Definition at line 49 of file igstkToken.h.


Constructor & Destructor Documentation

igstk::Token::Token (  ) 

Constructor.

It initializes all the member variables

virtual igstk::Token::~Token (  )  [virtual]

Destructor.


Member Function Documentation

virtual IdentifierType igstk::Token::GetIdentifier (  )  [virtual]

Returns the unique identifier of the current instance.

void igstk::Token::Print ( std::ostream &  os,
itk::Indent  indent 
) const

Method for printing out the member variables of this object to a ostream.

Warning:
A SetIndentifier() method should never be created since it will open a door for violating the uniqueness of the Identifier.
SetIndentifier(); Purposely not created.

virtual void igstk::Token::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const [protected, virtual]

Print the object information in a stream.


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

Generated on Thu Apr 9 21:38:53 2015 for IGSTK by  doxygen 1.5.6