FREE::SetupOptimizationProgressObserver Class Reference

Observation class for a setup optimization progress. More...

#include <freSetupOptimizationProgressObserver.h>

List of all members.

Public Types
typedef SetupOptimizationProgressObserver	Self
typedef itk::Command	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Static Public Member Functions
static Pointer	New (void)
Public Attributes
ProgressEventBase::Pointer	fnOnNotify
Protected Member Functions
	SetupOptimizationProgressObserver ()
virtual	~SetupOptimizationProgressObserver ()
void	Execute (itk::Object *caller, const itk::EventObject &rEvent)
void	Execute (const itk::Object *caller, const itk::EventObject &rEvent)

---

Detailed Description

Observation class for a setup optimization progress.

SetupOptimizationProgressObserver is used to observe the progress of a setup optimization (mainly used by SetupOptimizationProcesser) The observer only makes a notification, to interpret this and make use of it, is about the receiver of the notification.

Definition at line 46 of file freSetupOptimizationProgressObserver.h.

---

Member Typedef Documentation

typedef SetupOptimizationProgressObserver FREE::SetupOptimizationProgressObserver::Self

Standard class typedefs.

Definition at line 50 of file freSetupOptimizationProgressObserver.h.

typedef itk::Command FREE::SetupOptimizationProgressObserver::Superclass

Definition at line 51 of file freSetupOptimizationProgressObserver.h.

typedef itk::SmartPointer<Self> FREE::SetupOptimizationProgressObserver::Pointer

Definition at line 52 of file freSetupOptimizationProgressObserver.h.

typedef itk::SmartPointer<const Self> FREE::SetupOptimizationProgressObserver::ConstPointer

Definition at line 53 of file freSetupOptimizationProgressObserver.h.

---

Constructor & Destructor Documentation

FREE::SetupOptimizationProgressObserver::SetupOptimizationProgressObserver

(

)

[protected]

Definition at line 30 of file freSetupOptimizationProgressObserver.cxx.

References fnOnNotify.

FREE::SetupOptimizationProgressObserver::~SetupOptimizationProgressObserver

(

)

[protected, virtual]

Definition at line 36 of file freSetupOptimizationProgressObserver.cxx.

---

Member Function Documentation

static Pointer FREE::SetupOptimizationProgressObserver::New

(

void

)

[inline, static]

Special constructor function which provides the itk::Smartpointer feature to this class.

Definition at line 57 of file freSetupOptimizationProgressObserver.h.

Referenced by FREE::SetupOptimizationProcessor::StartOptimization().

virtual ::itk::LightObject::Pointer FREE::SetupOptimizationProgressObserver::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 57 of file freSetupOptimizationProgressObserver.h.

virtual const char* FREE::SetupOptimizationProgressObserver::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 58 of file freSetupOptimizationProgressObserver.h.

void FREE::SetupOptimizationProgressObserver::Execute	(	itk::Object *	caller,
		const itk::EventObject &	rEvent
	)			[protected]

Definition at line 40 of file freSetupOptimizationProgressObserver.cxx.

void FREE::SetupOptimizationProgressObserver::Execute	(	const itk::Object *	caller,
		const itk::EventObject &	rEvent
	)			[protected]

Function is called, when the observed itk class generates an itk::EventObject.

Parameters:

[in]	caller	Pointer to the itk object, where the event is coming from.
[in]	rEvent	Reference to the itk::EventObject. The SetupOptimizationProgressObserver cares only about itk:IterationEvents.

Definition at line 47 of file freSetupOptimizationProgressObserver.cxx.

References FREE::EvaluationProgressObserverEvent::CheckEvent(), fnOnNotify, FREE::EvaluationProgressObserverEvent::GetComment(), and FREE::EvaluationProgressObserverEvent::GetStatusID().

Here is the call graph for this function:

---

Member Data Documentation

ProgressEventBase::Pointer FREE::SetupOptimizationProgressObserver::fnOnNotify

Event that triggers, when the observer gets an itk::IterationEvent. At default it is NULL and no function will be called.

Definition at line 58 of file freSetupOptimizationProgressObserver.h.

Referenced by Execute(), and SetupOptimizationProgressObserver().

---

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

• freSetupOptimizationProgressObserver.h
• freSetupOptimizationProgressObserver.cxx

---