mitk::NonBlockingAlgorithmEvent Class Reference

Base event class for NonBlockingAlgorithm notifications. More...

#include <mitkNonBlockingAlgorithmEvents.h>

Inheritance diagram for mitk::NonBlockingAlgorithmEvent:

Collaboration diagram for mitk::NonBlockingAlgorithmEvent:

Public Types
typedef NonBlockingAlgorithmEvent	Self
typedef itk::AnyEvent	Superclass

Public Member Functions
	NonBlockingAlgorithmEvent (const NonBlockingAlgorithm *algorithm=nullptr)
	Construct the event, optionally referencing the originating algorithm. More...
	~NonBlockingAlgorithmEvent () override
const char *	GetEventName () const override
	Return the human-readable name of this event. More...
bool	CheckEvent (const ::itk::EventObject *e) const override
	Check whether a given event object is of this type. More...
::itk::EventObject *	MakeObject () const override
	Create a copy of this event on the heap. More...
const mitk::NonBlockingAlgorithm *	GetAlgorithm () const
	Get the algorithm that raised this event. More...
	NonBlockingAlgorithmEvent (const Self &s)
	Copy constructor. More...

Protected Attributes
mitk::NonBlockingAlgorithm::ConstPointer	m_Algorithm
	The algorithm that raised this event. More...

Detailed Description

Base event class for NonBlockingAlgorithm notifications.

This event is emitted by NonBlockingAlgorithm to notify observers about state changes. It carries a const pointer to the algorithm that raised the event.

See also

NonBlockingAlgorithm

ResultAvailable

ProcessingError

Definition at line 32 of file mitkNonBlockingAlgorithmEvents.h.

Member Typedef Documentation

Self

typedef NonBlockingAlgorithmEvent mitk::NonBlockingAlgorithmEvent::Self

Definition at line 35 of file mitkNonBlockingAlgorithmEvents.h.

Superclass

typedef itk::AnyEvent mitk::NonBlockingAlgorithmEvent::Superclass

Definition at line 36 of file mitkNonBlockingAlgorithmEvents.h.

Constructor & Destructor Documentation

NonBlockingAlgorithmEvent() [1/2]

mitk::NonBlockingAlgorithmEvent::NonBlockingAlgorithmEvent ( const NonBlockingAlgorithm *  algorithm = nullptr )

inline

Construct the event, optionally referencing the originating algorithm.

Parameters

[in]

algorithm

Pointer to the algorithm that raised the event, or nullptr.

Definition at line 42 of file mitkNonBlockingAlgorithmEvents.h.

~NonBlockingAlgorithmEvent()

mitk::NonBlockingAlgorithmEvent::~NonBlockingAlgorithmEvent ( )

inlineoverride

Definition at line 43 of file mitkNonBlockingAlgorithmEvents.h.

NonBlockingAlgorithmEvent() [2/2]

mitk::NonBlockingAlgorithmEvent::NonBlockingAlgorithmEvent ( const Self &  s )

inline

Copy constructor.

Definition at line 68 of file mitkNonBlockingAlgorithmEvents.h.

Member Function Documentation

CheckEvent()

bool mitk::NonBlockingAlgorithmEvent::CheckEvent ( const ::itk::EventObject *  e ) const

inlineoverride

Check whether a given event object is of this type.

Parameters

[in]

e

The event object to check.

Returns

True if e is a NonBlockingAlgorithmEvent.

Definition at line 53 of file mitkNonBlockingAlgorithmEvents.h.

GetAlgorithm()

const mitk::NonBlockingAlgorithm* mitk::NonBlockingAlgorithmEvent::GetAlgorithm ( ) const

inline

Get the algorithm that raised this event.

Returns

Const pointer to the originating NonBlockingAlgorithm, or nullptr.

Definition at line 65 of file mitkNonBlockingAlgorithmEvents.h.

References m_Algorithm.

GetEventName()

const char* mitk::NonBlockingAlgorithmEvent::GetEventName ( ) const

inlineoverride

Return the human-readable name of this event.

Definition at line 46 of file mitkNonBlockingAlgorithmEvents.h.

MakeObject()

::itk::EventObject* mitk::NonBlockingAlgorithmEvent::MakeObject ( ) const

inlineoverride

Create a copy of this event on the heap.

Returns

A new NonBlockingAlgorithmEvent.

Definition at line 59 of file mitkNonBlockingAlgorithmEvents.h.

References m_Algorithm.

Member Data Documentation

m_Algorithm

mitk::NonBlockingAlgorithm::ConstPointer mitk::NonBlockingAlgorithmEvent::m_Algorithm

protected

The algorithm that raised this event.

Definition at line 71 of file mitkNonBlockingAlgorithmEvents.h.

Referenced by GetAlgorithm(), and MakeObject().

---

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

• mitkNonBlockingAlgorithmEvents.h