FREE::LevelEvent< T > Class Template Reference
[Events]

Event object for level events in f.r.e.e.. More...

#include <freRegistrationEvents.h>

Inheritance diagram for FREE::LevelEvent< T >:

[legend]

Collaboration diagram for FREE::LevelEvent< T >:

[legend]

List of all members.

Public Types
typedef void(T::*	NextLevelEvent )(const unsigned int iID, void *pSender, long threadID)
typedef itk::SmartPointer < LevelEvent< T > >	Pointer
Public Member Functions
	freNewEventMacro (LevelEvent, T, NextLevelEvent)
	itkTypeMacro (LevelEvent, LevelEventBase)
virtual void	Execute (const unsigned int iID, void *pSender, long threadID=0)
Protected Member Functions
	LevelEvent (T *pObject, NextLevelEvent pNLE)
Private Attributes
T *	m_Object
NextLevelEvent	m_LevelEvent

---

Detailed Description

template<typename T>
class FREE::LevelEvent< T >

Event object for level events in f.r.e.e..

LevelEvent is the event object for the interaction with RegistrationObserver. A RegistrationObserver makes a Callback by the use of this event Object.

Other then the EventBase this object is used by a class to pass a member function as a function pointer, to allow a callback. the template T is the class, which offers the function pointer. (This difference between Event and EventBase is needed, because the call of member function always passes a hidden pointer (this-pointer), unlike a global function.

Definition at line 171 of file freRegistrationEvents.h.

---

Member Typedef Documentation

template<typename T>

typedef void(T::* FREE::LevelEvent< T >::NextLevelEvent)(const unsigned int iID, void *pSender, long threadID)

Reimplemented from FREE::LevelEventBase.

Definition at line 174 of file freRegistrationEvents.h.

template<typename T>

typedef itk::SmartPointer<LevelEvent<T> > FREE::LevelEvent< T >::Pointer

Reimplemented from FREE::LevelEventBase.

Definition at line 176 of file freRegistrationEvents.h.

---

Constructor & Destructor Documentation

template<typename T>

FREE::LevelEvent< T >::LevelEvent	(	T *	pObject,
		NextLevelEvent< T >	pNLE
	)			[inline, protected]

Definition at line 186 of file freRegistrationEvents.h.

---

Member Function Documentation

template<typename T>

FREE::LevelEvent< T >::freNewEventMacro	(	LevelEvent< T >	,
		T	,
		NextLevelEvent< T >
	)

template<typename T>

FREE::LevelEvent< T >::itkTypeMacro	(	LevelEvent< T >	,
		LevelEventBase
	)

template<typename T>

virtual void FREE::LevelEvent< T >::Execute	(	const unsigned int	iID,
		void *	pSender,
		long	threadID = 0
	)			[inline, virtual]

Event type that is used, if the processor starts registration with a new level of resolution or a new section is reached. pSender is the pointer to the object how called the event.

Parameters:

[in]	iID	Actual ID of the level/section.
[in]	pSender	Pointer to the object, which called the event.
[in]	threadID	ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender.

Reimplemented from FREE::LevelEventBase.

Definition at line 200 of file freRegistrationEvents.h.

---

Member Data Documentation

template<typename T>

T* FREE::LevelEvent< T >::m_Object [private]

Definition at line 182 of file freRegistrationEvents.h.

Referenced by FREE::LevelEvent< FREE::RegistrationProcessEventHandler >::Execute().

template<typename T>

NextLevelEvent FREE::LevelEvent< T >::m_LevelEvent [private]

Reimplemented from FREE::LevelEventBase.

Definition at line 183 of file freRegistrationEvents.h.

Referenced by FREE::LevelEvent< FREE::RegistrationProcessEventHandler >::Execute().

---

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

• freRegistrationEvents.h

---