mitk::StateMachineContainer Class Reference

#include <mitkStateMachineContainer.h>

Inheritance diagram for mitk::StateMachineContainer:

Collaboration diagram for mitk::StateMachineContainer:

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 ()
	~StateMachineContainer () override
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 39 of file mitkStateMachineContainer.h.

Member Typedef Documentation

StateMachineCollectionType

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

This type holds all states of one statemachine.

Definition at line 48 of file mitkStateMachineContainer.h.

Constructor & Destructor Documentation

StateMachineContainer()

mitk::StateMachineContainer::StateMachineContainer ( )

protected

Definition at line 48 of file mitkStateMachineContainer.cpp.

~StateMachineContainer()

mitk::StateMachineContainer::~StateMachineContainer ( )

overrideprotected

Definition at line 52 of file mitkStateMachineContainer.cpp.

Member Function Documentation

EndElement()

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

overrideprotected

Derived from XMLReader.

Definition at line 179 of file mitkStateMachineContainer.cpp.

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

GetStartState()

mitk::StateMachineState::Pointer mitk::StateMachineContainer::GetStartState

(

)

const

Returns the StartState of the StateMachine.

Definition at line 76 of file mitkStateMachineContainer.cpp.

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

LoadBehavior()

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 59 of file mitkStateMachineContainer.cpp.

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

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

New()

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

static

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

StartElement()

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

overrideprotected

Derived from XMLReader.

Definition at line 93 of file mitkStateMachineContainer.cpp.

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

vtkTypeMacro()

mitk::StateMachineContainer::vtkTypeMacro	(	StateMachineContainer	,
		vtkXMLParser
	)

---

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

• mitkStateMachineContainer.h
• mitkStateMachineContainer.cpp