FREE::RegistrationProgressEventBase Class Reference
[Events]

Abstract event object for progress events in f.r.e.e.. More...

#include <freRegistrationEvents.h>

Inheritance diagram for FREE::RegistrationProgressEventBase:

[legend]

Collaboration diagram for FREE::RegistrationProgressEventBase:

[legend]

List of all members.

Public Types
typedef void(*	ProgEvent )(const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID)
typedef itk::SmartPointer < RegistrationProgressEventBase >	Pointer
Public Member Functions
	freNewEventBaseMacro (RegistrationProgressEventBase, ProgEvent)
	itkTypeMacro (RegistrationProgressEventBase, NotificationEventBase)
virtual void	Execute (const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID=0)
Protected Member Functions
	RegistrationProgressEventBase ()
	RegistrationProgressEventBase (ProgEvent pPE)
Private Attributes
ProgEvent	m_ProgressEvent

---

Detailed Description

Abstract event object for progress events in f.r.e.e..

RegistrationProgressEventBase is the generic event object within f.r.e.e. and used for realize callbacks to nonstatic member functions of f.r.e.e. Objects.

Definition at line 212 of file freRegistrationEvents.h.

---

Member Typedef Documentation

typedef void(* FREE::RegistrationProgressEventBase::ProgEvent)(const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID)

Reimplemented in FREE::RegistrationProgressEvent< T >, and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >.

Definition at line 215 of file freRegistrationEvents.h.

typedef itk::SmartPointer<RegistrationProgressEventBase> FREE::RegistrationProgressEventBase::Pointer

Reimplemented from FREE::NotificationEventBase.

Reimplemented in FREE::RegistrationProgressEvent< T >, and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >.

Definition at line 220 of file freRegistrationEvents.h.

---

Constructor & Destructor Documentation

FREE::RegistrationProgressEventBase::RegistrationProgressEventBase

(

)

[protected]

Implementation of FREE::RegistrationProgressEventBase //////////////

Definition at line 77 of file freRegistrationEvents.cxx.

References m_ProgressEvent.

FREE::RegistrationProgressEventBase::RegistrationProgressEventBase

(

ProgEvent

pPE

)

[protected]

Definition at line 80 of file freRegistrationEvents.cxx.

References m_ProgressEvent.

---

Member Function Documentation

FREE::RegistrationProgressEventBase::freNewEventBaseMacro	(	RegistrationProgressEventBase	,
		ProgEvent
	)

FREE::RegistrationProgressEventBase::itkTypeMacro	(	RegistrationProgressEventBase	,
		NotificationEventBase
	)

void FREE::RegistrationProgressEventBase::Execute	(	const RegistrationStatusType	status,
		const std::string	sComment,
		void *	pSender,
		long	threadID = 0
	)			[virtual]

Event type that is used, if an iteration is finished. The actual values and position of the optimizer are passed with the event. pSender is the pointer to the object how called the event.

Parameters:

[in]	status	Actual status of the registration process progress.
[in]	sComment	String for adding any comments concerning the new status.
[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 in FREE::RegistrationProgressEvent< T >, and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >.

Definition at line 87 of file freRegistrationEvents.cxx.

---

Member Data Documentation

ProgEvent FREE::RegistrationProgressEventBase::m_ProgressEvent [private]

Reimplemented in FREE::RegistrationProgressEvent< T >, and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >.

Definition at line 226 of file freRegistrationEvents.h.

Referenced by RegistrationProgressEventBase().

---

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

• freRegistrationEvents.h
• freRegistrationEvents.cxx

---