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

Represents a condition, that has to be fulfilled in order to execute a state machine transition after a certain event. More...

#include <mitkStateMachineCondition.h>

Public Member Functions

 StateMachineCondition (const std::string &, const bool inverted)
 
 ~StateMachineCondition ()
 
std::string GetConditionName () const
 Returns the String-Id of this action. More...
 
bool IsInverted () const
 

Detailed Description

Represents a condition, that has to be fulfilled in order to execute a state machine transition after a certain event.

This class represents a condition in the interaction framework. A condition corresponds to a transition (StateMachineTransition) between two states (StateMachineState) and models one requirement that has to be fulfilled in order to execute its transition.

A condition returns either true or false. If the condition is to be inverted, the bool-flag m_Inverted is set to true.

example:

<state name="dummy-state">
<transition event="dummy-event" target="dummy-state">
<condition name="dummy_condition_fulfilled" /> <!-- condition is fulfilled -->
<action name"do_something" >
</transition>
<transition event="dummy-event" target="dummy-state">
<condition name="dummy_condition_fulfilled" inverted="true"/> <!-- condition is NOT fulfilled -->
<action name"do_something_else" >
</transition>
</state>

Definition at line 47 of file mitkStateMachineCondition.h.

Constructor & Destructor Documentation

◆ StateMachineCondition()

mitk::StateMachineCondition::StateMachineCondition ( const std::string &  ,
const bool  inverted 
)

◆ ~StateMachineCondition()

mitk::StateMachineCondition::~StateMachineCondition ( )

Member Function Documentation

◆ GetConditionName()

std::string mitk::StateMachineCondition::GetConditionName ( ) const

Returns the String-Id of this action.

◆ IsInverted()

bool mitk::StateMachineCondition::IsInverted ( ) const

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