mitk::StateMachineState Class Reference

#include <mitkStateMachineState.h>

Inheritance diagram for mitk::StateMachineState:

Collaboration diagram for mitk::StateMachineState:

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 () override

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 30 of file mitkStateMachineState.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 33 of file mitkStateMachineState.h.

Pointer

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

Definition at line 33 of file mitkStateMachineState.h.

Self

typedef StateMachineState mitk::StateMachineState::Self

Definition at line 33 of file mitkStateMachineState.h.

StateMap

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

Definition at line 34 of file mitkStateMachineState.h.

Superclass

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

Definition at line 33 of file mitkStateMachineState.h.

TransitionVector

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

Definition at line 37 of file mitkStateMachineState.h.

Constructor & Destructor Documentation

StateMachineState()

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

protected

~StateMachineState()

mitk::StateMachineState::~StateMachineState ( )

overrideprotected

Member Function Documentation

AddTransition()

bool mitk::StateMachineState::AddTransition

(

StateMachineTransition::Pointer

transition

)

ConnectTransitions()

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.

GetClassHierarchy()

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

inlinevirtual

Definition at line 33 of file mitkStateMachineState.h.

GetClassName()

virtual const char* mitk::StateMachineState::GetClassName ( ) const

virtual

GetMode()

std::string mitk::StateMachineState::GetMode

(

)

const

GetName()

std::string mitk::StateMachineState::GetName

(

)

const

Returns the name.

GetStaticNameOfClass()

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

inlinestatic

Definition at line 33 of file mitkStateMachineState.h.

GetTransition()

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.

GetTransitionList()

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

Return Transitions that match given event description.

New()

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

inlinestatic

Definition at line 34 of file mitkStateMachineState.h.

---

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

• mitkStateMachineState.h