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

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

#include <freRegistrationEvents.h>

Inheritance diagram for FREE::RegistrationProgressEvent< T >:

Inheritance graph
FREE::RegistrationProgressEventBaseFREE::NotificationEventBase
[legend]
Collaboration diagram for FREE::RegistrationProgressEvent< T >:

Collaboration graph
FREE::RegistrationProgressEventBaseFREE::NotificationEventBase
[legend]

List of all members.

Public Types

typedef void(T::* ProgEvent )(const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID)
typedef
itk::SmartPointer
< RegistrationProgressEvent
< T > > 
Pointer

Public Member Functions

 freNewEventMacro (RegistrationProgressEvent, T, ProgEvent)
 itkTypeMacro (RegistrationProgressEvent, RegistrationProgressEventBase)
virtual void Execute (const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID=0)

Protected Member Functions

 RegistrationProgressEvent (T *pObject, ProgEvent pPE)

Private Attributes

T * m_Object
ProgEvent m_ProgressEvent


Detailed Description

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

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

RegistrationProgressEvent is an event object within f.r.e.e. and used for realize callbacks on different general states of a Registration process.

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 263 of file freRegistrationEvents.h.


Member Typedef Documentation

template<typename T>
typedef void(T::* FREE::RegistrationProgressEvent< T >::ProgEvent)(const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID)

Reimplemented from FREE::RegistrationProgressEventBase.

Definition at line 266 of file freRegistrationEvents.h.

template<typename T>
typedef itk::SmartPointer<RegistrationProgressEvent<T> > FREE::RegistrationProgressEvent< T >::Pointer

Reimplemented from FREE::RegistrationProgressEventBase.

Definition at line 271 of file freRegistrationEvents.h.


Constructor & Destructor Documentation

template<typename T>
FREE::RegistrationProgressEvent< T >::RegistrationProgressEvent ( T *  pObject,
ProgEvent  pPE 
) [inline, protected]

Definition at line 281 of file freRegistrationEvents.h.


Member Function Documentation

template<typename T>
FREE::RegistrationProgressEvent< T >::freNewEventMacro ( RegistrationProgressEvent< T >  ,
,
ProgEvent   
)

template<typename T>
FREE::RegistrationProgressEvent< T >::itkTypeMacro ( RegistrationProgressEvent< T >  ,
RegistrationProgressEventBase   
)

template<typename T>
virtual void FREE::RegistrationProgressEvent< T >::Execute ( const RegistrationStatusType  status,
const std::string  sComment,
void *  pSender,
long  threadID = 0 
) [inline, 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 from FREE::RegistrationProgressEventBase.

Definition at line 297 of file freRegistrationEvents.h.


Member Data Documentation

template<typename T>
T* FREE::RegistrationProgressEvent< T >::m_Object [private]

Definition at line 277 of file freRegistrationEvents.h.

Referenced by FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >::Execute(), and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >::RegistrationProgressEvent().

template<typename T>
ProgEvent FREE::RegistrationProgressEvent< T >::m_ProgressEvent [private]

Reimplemented from FREE::RegistrationProgressEventBase.

Definition at line 278 of file freRegistrationEvents.h.

Referenced by FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >::Execute(), and FREE::RegistrationProgressEvent< FREE::RegistrationProcessEventHandler >::RegistrationProgressEvent().


The documentation for this class was generated from the following file:
Generated at Sat Oct 13 18:29:23 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000