mitk::ParameterToolEvent< T > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

Inheritance diagram for mitk::ParameterToolEvent< T >:

Collaboration diagram for mitk::ParameterToolEvent< T >:

Public Types
typedef ParameterToolEvent	Self
typedef ToolEvent	Superclass

Public Member Functions
	ParameterToolEvent (const T parameter)
	Constructor with parameter value. More...
	ParameterToolEvent (const Self &s)
	Copy constructor. More...
	~ParameterToolEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const ::itk::EventObject *e) const override
::itk::EventObject *	MakeObject () const override
const T	GetParameter () const
	Returns the parameter value carried by this event. More...

Protected Attributes
const T	m_Parameter

Detailed Description

template<typename T>
class mitk::ParameterToolEvent< T >

Tool event with 1 parameter.

Can store one parameter for use within an observer. To derive your own special events, use the mitkToolEventMacro1Param macro.

namespace mitk
{
 
class MyTool : public Tool
{
  public:
 
    mitkToolEventMacro1Param(FooToolEvent, int);
 
  [...]
 
  protected:
 
  // Invoke your event like this
  void YourExampleMethod()
  {
    InvokeEvent( FooToolEvent(32) );
  }
};
 
}

Tool event carrying a single typed parameter.

Use the mitkToolEventMacro1Param macro to derive named event types from this template.

Template Parameters

T	The type of the parameter carried by the event.

See also

ToolEvent, TwoParameterToolEvent

Definition at line 100 of file mitkToolEvents.h.

Member Typedef Documentation

Self

template<typename T >

typedef ParameterToolEvent mitk::ParameterToolEvent< T >::Self

Definition at line 103 of file mitkToolEvents.h.

Superclass

template<typename T >

typedef ToolEvent mitk::ParameterToolEvent< T >::Superclass

Definition at line 104 of file mitkToolEvents.h.

Constructor & Destructor Documentation

ParameterToolEvent() [1/2]

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent ( const T  parameter )

inline

Constructor with parameter value.

Parameters

[in]

parameter

The parameter value to store.

Definition at line 110 of file mitkToolEvents.h.

ParameterToolEvent() [2/2]

template<typename T >

mitk::ParameterToolEvent< T >::ParameterToolEvent ( const Self &  s )

inline

Copy constructor.

Definition at line 113 of file mitkToolEvents.h.

~ParameterToolEvent()

template<typename T >

mitk::ParameterToolEvent< T >::~ParameterToolEvent ( )

inlineoverride

Definition at line 114 of file mitkToolEvents.h.

Member Function Documentation

CheckEvent()

template<typename T >

bool mitk::ParameterToolEvent< T >::CheckEvent ( const ::itk::EventObject *  e ) const

inlineoverride

Definition at line 116 of file mitkToolEvents.h.

GetEventName()

template<typename T >

const char* mitk::ParameterToolEvent< T >::GetEventName ( ) const

inlineoverride

Definition at line 115 of file mitkToolEvents.h.

GetParameter()

template<typename T >

const T mitk::ParameterToolEvent< T >::GetParameter ( ) const

inline

Returns the parameter value carried by this event.

Returns

The parameter value.

Definition at line 123 of file mitkToolEvents.h.

References mitk::ParameterToolEvent< T >::m_Parameter.

MakeObject()

template<typename T >

::itk::EventObject* mitk::ParameterToolEvent< T >::MakeObject ( ) const

inlineoverride

Definition at line 117 of file mitkToolEvents.h.

References mitk::ParameterToolEvent< T >::m_Parameter.

Member Data Documentation

m_Parameter

template<typename T >

const T mitk::ParameterToolEvent< T >::m_Parameter

protected

Definition at line 125 of file mitkToolEvents.h.

Referenced by mitk::ParameterToolEvent< T >::GetParameter(), and mitk::ParameterToolEvent< T >::MakeObject().

---

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

• mitkToolEvents.h