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::StateMachineContainer Class Reference
MITK Modules » Core » Interaction and Undo Classes » Interaction Classes

#include <mitkStateMachineContainer.h>

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

Public Types

typedef std::vector< StateMachineState::Pointer > StateMachineCollectionType
 This type holds all states of one statemachine. More...
 

Public Member Functions

 vtkTypeMacro (StateMachineContainer, vtkXMLParser)
 
StateMachineState::Pointer GetStartState () const
 Returns the StartState of the StateMachine. More...
 
bool LoadBehavior (const std::string &fileName, const us::Module *module)
 Loads XML resource. More...
 

Static Public Member Functions

static StateMachineContainer * New ()
 

Protected Member Functions

 StateMachineContainer ()
 
virtual ~StateMachineContainer ()
 
void StartElement (const char *elementName, const char **atts) override
 Derived from XMLReader. More...
 
void EndElement (const char *elementName) override
 Derived from XMLReader. More...
 

Detailed Description

Definition at line 43 of file mitkStateMachineContainer.h.

Member Typedef Documentation

typedef std::vector<StateMachineState::Pointer> mitk::StateMachineContainer::StateMachineCollectionType

This type holds all states of one statemachine.

Definition at line 52 of file mitkStateMachineContainer.h.

Constructor & Destructor Documentation

mitk::StateMachineContainer::StateMachineContainer ( )
protected

Definition at line 52 of file mitkStateMachineContainer.cpp.

mitk::StateMachineContainer::~StateMachineContainer ( )
protectedvirtual

Definition at line 56 of file mitkStateMachineContainer.cpp.

Member Function Documentation

void mitk::StateMachineContainer::EndElement ( const char *  elementName)
overrideprotected

Derived from XMLReader.

Definition at line 183 of file mitkStateMachineContainer.cpp.

References ACTION, CONDITION, CONFIG, MITK_ERROR, STATE, and TRANSITION.

mitk::StateMachineState::Pointer mitk::StateMachineContainer::GetStartState ( ) const

Returns the StartState of the StateMachine.

Definition at line 80 of file mitkStateMachineContainer.cpp.

Referenced by mitkStateMachineContainerTest().

bool mitk::StateMachineContainer::LoadBehavior ( const std::string &  fileName,
const us::Module *  module 
)

Loads XML resource.

Loads the xml file filename and generates the necessary instances.

Loads a XML resource file in the given module context. The files have to be placed in the Resources/Interaction folder of their respective module.

Definition at line 63 of file mitkStateMachineContainer.cpp.

References ModuleContext::GetModule(), us::GetModuleContext(), us::Module::GetResource(), us::ModuleResource::IsValid(), and mitkThrow.

Referenced by mitkStateMachineContainerTest().

static StateMachineContainer* mitk::StateMachineContainer::New ( )
static

Referenced by mitk::EventStateMachine::LoadStateMachine(), and mitkStateMachineContainerTest().

void mitk::StateMachineContainer::StartElement ( const char *  elementName,
const char **  atts 
)
overrideprotected

Derived from XMLReader.

Definition at line 97 of file mitkStateMachineContainer.cpp.

References ACTION, CONDITION, CONFIG, EVENTCLASS, EVENTVARIANT, INVERTED, MITK_WARN, NAME, mitk::StateMachineAction::New(), mitk::StateMachineState::New(), mitk::StateMachineTransition::New(), STARTSTATE, STATE, STATEMODE, TARGET, and TRANSITION.

mitk::StateMachineContainer::vtkTypeMacro ( StateMachineContainer  ,
vtkXMLParser   
)
The documentation for this class was generated from the following files: