Medical Imaging Interaction Toolkit  2018.4.99-701c8286
Medical Imaging Interaction Toolkit
mitk::StateMachineTransition Class Reference

Connects two states, and holds references to corresponding actions and conditions. More...

#include <mitkStateMachineTransition.h>

Inheritance diagram for mitk::StateMachineTransition:
Collaboration diagram for mitk::StateMachineTransition:

Public Types

typedef StateMachineTransition Self
 
typedef itk::LightObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
SpStateMachineState GetNextState () const
 
std::string GetNextStateName () const
 
bool operator== (const StateMachineTransition &transition) const
 
ActionVectorType GetActions () const
 Get an iterator on the first action in list. More...
 
const ConditionVectorTypeGetConditions () const
 
void SetNextState (const SpStateMachineState &nextState)
 Set the next state of this object. More...
 

Static Public Member Functions

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

Protected Member Functions

 StateMachineTransition (const std::string &nextStateName, const std::string &eventClass, const std::string &eventVariant)
 
 ~StateMachineTransition () override
 

Protected Attributes

std::string m_EventClass
 
std::string m_EventVariant
 

Detailed Description

Connects two states, and holds references to corresponding actions and conditions.

This class represents a transition between two states of a statemachine. It holds a list of conditions that have to be fulfilled in order to be executed correctly. It also holds a list of actions that will be executed if all conditions are fulfilled.

Definition at line 44 of file mitkStateMachineTransition.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

typedef itk::LightObject mitk::StateMachineTransition::Superclass

Definition at line 50 of file mitkStateMachineTransition.h.

Constructor & Destructor Documentation

◆ StateMachineTransition()

mitk::StateMachineTransition::StateMachineTransition ( const std::string &  nextStateName,
const std::string &  eventClass,
const std::string &  eventVariant 
)
protected

◆ ~StateMachineTransition()

mitk::StateMachineTransition::~StateMachineTransition ( )
overrideprotected

Member Function Documentation

◆ GetActions()

ActionVectorType mitk::StateMachineTransition::GetActions ( ) const

Get an iterator on the first action in list.

◆ GetClassHierarchy()

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

Definition at line 50 of file mitkStateMachineTransition.h.

◆ GetClassName()

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

◆ GetConditions()

const ConditionVectorType& mitk::StateMachineTransition::GetConditions ( ) const

◆ GetNextState()

SpStateMachineState mitk::StateMachineTransition::GetNextState ( ) const

◆ GetNextStateName()

std::string mitk::StateMachineTransition::GetNextStateName ( ) const

◆ GetStaticNameOfClass()

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

Definition at line 50 of file mitkStateMachineTransition.h.

◆ New()

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

Definition at line 51 of file mitkStateMachineTransition.h.

◆ operator==()

bool mitk::StateMachineTransition::operator== ( const StateMachineTransition transition) const

Check for equality. Equality is given if event variant is the same and classes are the same or the first argument is a superclass of the second. Here the order of arguments matters. !

◆ SetNextState()

void mitk::StateMachineTransition::SetNextState ( const SpStateMachineState nextState)

Set the next state of this object.

Member Data Documentation

◆ m_EventClass

std::string mitk::StateMachineTransition::m_EventClass
protected

Definition at line 81 of file mitkStateMachineTransition.h.

◆ m_EventVariant

std::string mitk::StateMachineTransition::m_EventVariant
protected

Definition at line 82 of file mitkStateMachineTransition.h.


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