mitk::Action Class Reference

Represents an action that is executed after a certain event in the state machine mechanism. More...

#include <mitkAction.h>

Inheritance diagram for mitk::Action:

Collaboration diagram for mitk::Action:

Public Member Functions
	mitkClassMacroItkParent (Action, itk::Object)
	mitkNewMacro1Param (Self, int)
	Static New method for SmartPointer-based construction. More...
void	AddProperty (const char *propertyKey, BaseProperty *property)
	Add a property to the action's property list. More...
int	GetActionId () const
	Get the ID of this action. More...
mitk::BaseProperty *	GetProperty (const char *propertyKey) const
	Get a property by its key. More...

Protected Member Functions
	Action (int actionId)
	Construct an action with the given ID. More...
	~Action () override
	Destructor. More...

Detailed Description

Represents an action that is executed after a certain event in the state machine mechanism.

An Action encapsulates an action ID and an optional set of properties that parameterize the action's behavior. Actions are used by the interaction state machine to execute responses to user input events.

See also

PropertyList

Definition at line 33 of file mitkAction.h.

Constructor & Destructor Documentation

Action()

mitk::Action::Action ( int  actionId )

protected

Construct an action with the given ID.

Parameters

[in]

actionId

The unique action identifier.

~Action()

mitk::Action::~Action ( )

overrideprotected

Destructor.

Member Function Documentation

AddProperty()

void mitk::Action::AddProperty	(	const char *	propertyKey,
		BaseProperty *	property
	)

Add a property to the action's property list.

Parameters

[in]	propertyKey	The key under which to store the property.
[in]	property	The property instance to add.

GetActionId()

int mitk::Action::GetActionId

(

)

const

Get the ID of this action.

Returns

The action ID.

GetProperty()

mitk::BaseProperty* mitk::Action::GetProperty

(

const char *

propertyKey

)

const

Get a property by its key.

Parameters

[in]

propertyKey

The key of the property to retrieve.

Returns

Pointer to the property, or nullptr if not found.

mitkClassMacroItkParent()

mitk::Action::mitkClassMacroItkParent	(	Action	,
		itk::Object
	)

mitkNewMacro1Param()

mitk::Action::mitkNewMacro1Param	(	Self	,
		int
	)

Static New method for SmartPointer-based construction.

---

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

• mitkAction.h