mitk::TwoParameterToolEvent< T, U > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

Inheritance diagram for mitk::TwoParameterToolEvent< T, U >:

Collaboration diagram for mitk::TwoParameterToolEvent< T, U >:

Public Types
typedef TwoParameterToolEvent	Self
typedef ToolEvent	Superclass

Public Member Functions
	TwoParameterToolEvent (const T parameter1, const U parameter2)
	Constructor with two parameter values. More...
	TwoParameterToolEvent (const Self &s)
	Copy constructor. More...
	~TwoParameterToolEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const ::itk::EventObject *e) const override
::itk::EventObject *	MakeObject () const override
const T	GetParameter1 () const
	Returns the first parameter value. More...
const U	GetParameter2 () const
	Returns the second parameter value. More...

Protected Attributes
const T	m_Parameter1
const U	m_Parameter2

Detailed Description

template<typename T, typename U>
class mitk::TwoParameterToolEvent< T, U >

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( BarToolEvent(32, false) );
  }
};
 
}

Tool event carrying two typed parameters.

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

Template Parameters

T	Type of the first parameter.
U	Type of the second parameter.

See also

ToolEvent, ParameterToolEvent

Definition at line 172 of file mitkToolEvents.h.

Member Typedef Documentation

Self

template<typename T , typename U >

typedef TwoParameterToolEvent mitk::TwoParameterToolEvent< T, U >::Self

Definition at line 175 of file mitkToolEvents.h.

Superclass

template<typename T , typename U >

typedef ToolEvent mitk::TwoParameterToolEvent< T, U >::Superclass

Definition at line 176 of file mitkToolEvents.h.

Constructor & Destructor Documentation

TwoParameterToolEvent() [1/2]

template<typename T , typename U >

mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent ( const T  parameter1, const U  parameter2  )

inline

Constructor with two parameter values.

Parameters

[in]	parameter1	The first parameter value.
[in]	parameter2	The second parameter value.

Definition at line 183 of file mitkToolEvents.h.

TwoParameterToolEvent() [2/2]

template<typename T , typename U >

mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent ( const Self &  s )

inline

Copy constructor.

Definition at line 188 of file mitkToolEvents.h.

~TwoParameterToolEvent()

template<typename T , typename U >

mitk::TwoParameterToolEvent< T, U >::~TwoParameterToolEvent ( )

inlineoverride

Definition at line 189 of file mitkToolEvents.h.

Member Function Documentation

CheckEvent()

template<typename T , typename U >

bool mitk::TwoParameterToolEvent< T, U >::CheckEvent ( const ::itk::EventObject *  e ) const

inlineoverride

Definition at line 191 of file mitkToolEvents.h.

GetEventName()

template<typename T , typename U >

const char* mitk::TwoParameterToolEvent< T, U >::GetEventName ( ) const

inlineoverride

Definition at line 190 of file mitkToolEvents.h.

GetParameter1()

template<typename T , typename U >

const T mitk::TwoParameterToolEvent< T, U >::GetParameter1 ( ) const

inline

Returns the first parameter value.

Definition at line 195 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter1.

GetParameter2()

template<typename T , typename U >

const U mitk::TwoParameterToolEvent< T, U >::GetParameter2 ( ) const

inline

Returns the second parameter value.

Definition at line 198 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter2.

MakeObject()

template<typename T , typename U >

::itk::EventObject* mitk::TwoParameterToolEvent< T, U >::MakeObject ( ) const

inlineoverride

Definition at line 192 of file mitkToolEvents.h.

References mitk::TwoParameterToolEvent< T, U >::m_Parameter1, and mitk::TwoParameterToolEvent< T, U >::m_Parameter2.

Member Data Documentation

m_Parameter1

template<typename T , typename U >

const T mitk::TwoParameterToolEvent< T, U >::m_Parameter1

protected

Definition at line 200 of file mitkToolEvents.h.

Referenced by mitk::TwoParameterToolEvent< T, U >::GetParameter1(), and mitk::TwoParameterToolEvent< T, U >::MakeObject().

m_Parameter2

template<typename T , typename U >

const U mitk::TwoParameterToolEvent< T, U >::m_Parameter2

protected

Definition at line 201 of file mitkToolEvents.h.

Referenced by mitk::TwoParameterToolEvent< T, U >::GetParameter2(), and mitk::TwoParameterToolEvent< T, U >::MakeObject().

---

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

• mitkToolEvents.h