Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::StateMachineState Class Reference

#include <mitkStateMachineState.h>

Inheritance diagram for mitk::StateMachineState:
Inheritance graph
[legend]
Collaboration diagram for mitk::StateMachineState:
Collaboration graph
[legend]

Public Types

typedef StateMachineState Self
 
typedef itk::LightObject Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef std::vector< mitk::StateMachineState::Pointer > StateMap
 
typedef std::vector< StateMachineTransition::Pointer > TransitionVector
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
bool AddTransition (StateMachineTransition::Pointer transition)
 
StateMachineTransition::Pointer GetTransition (const std::string &eventClass, const std::string &eventVariant)
 Return Transition which matches given event description. More...
 
TransitionVector GetTransitionList (const std::string &eventClass, const std::string &eventVariant)
 Return Transitions that match given event description. More...
 
std::string GetName () const
 Returns the name. More...
 
std::string GetMode () const
 
bool ConnectTransitions (StateMap *allStates)
 Searches dedicated States of all Transitions and sets *nextState of these Transitions. Required for this is a List of all build States of that StateMachine (allStates). This way the StateMachine can be build up. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New (const std::string &_arga, const std::string &_argb)
 

Protected Member Functions

 StateMachineState (const std::string &name, const std::string &stateMode)
 
 ~StateMachineState ()
 

Detailed Description

Represents a state of a state machine pattern. It holds transitions to other states (mitk::StateMachineTransition) and the mode of the current state, see m_StateMode .

Definition at line 34 of file mitkStateMachineState.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::StateMachineState::ConstPointer

Definition at line 37 of file mitkStateMachineState.h.

typedef itk::SmartPointer<Self> mitk::StateMachineState::Pointer

Definition at line 37 of file mitkStateMachineState.h.

typedef StateMachineState mitk::StateMachineState::Self

Definition at line 37 of file mitkStateMachineState.h.

typedef std::vector<mitk::StateMachineState::Pointer> mitk::StateMachineState::StateMap

Definition at line 38 of file mitkStateMachineState.h.

typedef itk::LightObject mitk::StateMachineState::Superclass

Definition at line 37 of file mitkStateMachineState.h.

typedef std::vector<StateMachineTransition::Pointer> mitk::StateMachineState::TransitionVector

Definition at line 41 of file mitkStateMachineState.h.

Constructor & Destructor Documentation

mitk::StateMachineState::StateMachineState ( const std::string &  name,
const std::string &  stateMode 
)
protected

Definition at line 19 of file mitkStateMachineState.cpp.

mitk::StateMachineState::~StateMachineState ( )
protected

Definition at line 29 of file mitkStateMachineState.cpp.

Member Function Documentation

bool mitk::StateMachineState::AddTransition ( StateMachineTransition::Pointer  transition)

Definition at line 34 of file mitkStateMachineState.cpp.

bool mitk::StateMachineState::ConnectTransitions ( StateMap *  allStates)

Searches dedicated States of all Transitions and sets *nextState of these Transitions. Required for this is a List of all build States of that StateMachine (allStates). This way the StateMachine can be build up.

Post-processing step, when builing StateMachine from XML. Parse all transitions and find the State that matches the String-Name.

Definition at line 88 of file mitkStateMachineState.cpp.

References MITK_WARN.

virtual std::vector<std::string> mitk::StateMachineState::GetClassHierarchy ( ) const
inlinevirtual

Definition at line 37 of file mitkStateMachineState.h.

virtual const char* mitk::StateMachineState::GetClassName ( ) const
virtual
std::string mitk::StateMachineState::GetMode ( ) const

Definition at line 24 of file mitkStateMachineState.cpp.

std::string mitk::StateMachineState::GetName ( ) const

Returns the name.

Definition at line 79 of file mitkStateMachineState.cpp.

static const char* mitk::StateMachineState::GetStaticNameOfClass ( )
inlinestatic

Definition at line 37 of file mitkStateMachineState.h.

mitk::StateMachineTransition::Pointer mitk::StateMachineState::GetTransition ( const std::string &  eventClass,
const std::string &  eventVariant 
)

Return Transition which matches given event description.

Deprecated:
(as of 2013_09) Use method GetTransitionList() instead.

Definition at line 45 of file mitkStateMachineState.cpp.

References MITK_WARN.

mitk::StateMachineState::TransitionVector mitk::StateMachineState::GetTransitionList ( const std::string &  eventClass,
const std::string &  eventVariant 
)

Return Transitions that match given event description.

Definition at line 66 of file mitkStateMachineState.cpp.

References mitk::StateMachineTransition::New().

static Pointer mitk::StateMachineState::New ( const std::string &  _arga,
const std::string &  _argb 
)
inlinestatic

Definition at line 38 of file mitkStateMachineState.h.

Referenced by mitk::StateMachineContainer::StartElement().

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