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

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

#include <freSetupOptimizationEvents.h>

Inheritance diagram for FREE::SetOpIterationEvent< T >:

[legend]

Collaboration diagram for FREE::SetOpIterationEvent< T >:

[legend]

List of all members.

Public Types
typedef void(T::*	NextIterationEvent )(const long &lIteration, const ComposedMetricMeasureType &composedMeasure, const MetricMeasureType &measure, const ParametersType &parameters, void *pSender)
typedef itk::SmartPointer < SetOpIterationEvent < T > >	Pointer
Public Member Functions
	freNewEventMacro (SetOpIterationEvent, T, NextIterationEvent)
	itkTypeMacro (SetOpIterationEvent, SetOpIterationEventBase)
virtual void	Execute (const long &lIteration, const ComposedMetricMeasureType &composedMeasure, const MetricMeasureType &measure, const ParametersType &parameters, void *pSender)
Protected Member Functions
	SetOpIterationEvent (T *pObject, NextIterationEvent pNIE)
Private Attributes
T *	m_Object
NextIterationEvent	m_IterationEvent

---

Detailed Description

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

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

Definition at line 83 of file freSetupOptimizationEvents.h.

---

Member Typedef Documentation

template<typename T>

typedef void(T::* FREE::SetOpIterationEvent< T >::NextIterationEvent)(const long &lIteration, const ComposedMetricMeasureType &composedMeasure, const MetricMeasureType &measure, const ParametersType &parameters, void *pSender)

Reimplemented from FREE::SetOpIterationEventBase.

Definition at line 86 of file freSetupOptimizationEvents.h.

template<typename T>

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

Reimplemented from FREE::SetOpIterationEventBase.

Definition at line 88 of file freSetupOptimizationEvents.h.

---

Constructor & Destructor Documentation

template<typename T>

FREE::SetOpIterationEvent< T >::SetOpIterationEvent	(	T *	pObject,
		NextIterationEvent	pNIE
	)			[inline, protected]

Definition at line 98 of file freSetupOptimizationEvents.h.

References FREE::SetOpIterationEvent< T >::m_IterationEvent, and FREE::SetOpIterationEvent< T >::m_Object.

---

Member Function Documentation

template<typename T>

FREE::SetOpIterationEvent< T >::freNewEventMacro	(	SetOpIterationEvent< T >	,
		T	,
		NextIterationEvent
	)

template<typename T>

FREE::SetOpIterationEvent< T >::itkTypeMacro	(	SetOpIterationEvent< T >	,
		SetOpIterationEventBase
	)

template<typename T>

virtual void FREE::SetOpIterationEvent< T >::Execute	(	const long &	lIteration,
		const ComposedMetricMeasureType &	composedMeasure,
		const MetricMeasureType &	measure,
		const ParametersType &	parameters,
		void *	pSender
	)			[inline, virtual]

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

Parameters:

[in]	lIteration	Number of the iteration.
[in]	composedMeasure	Actual value of the optimizer when the event was called. The value is composed with the weightened measure values
[in]	measure	Actual measure of the costfunction.
[in]	parameters	Actual parameter position of the optimizer.
[in]	pSender	Pointer to the object, which called the event.

Definition at line 114 of file freSetupOptimizationEvents.h.

References FREE::SetOpIterationEvent< T >::m_IterationEvent, and FREE::SetOpIterationEvent< T >::m_Object.

---

Member Data Documentation

template<typename T>

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

Definition at line 94 of file freSetupOptimizationEvents.h.

Referenced by FREE::SetOpIterationEvent< T >::Execute(), and FREE::SetOpIterationEvent< T >::SetOpIterationEvent().

template<typename T>

NextIterationEvent FREE::SetOpIterationEvent< T >::m_IterationEvent [private]

Reimplemented from FREE::SetOpIterationEventBase.

Definition at line 95 of file freSetupOptimizationEvents.h.

Referenced by FREE::SetOpIterationEvent< T >::Execute(), and FREE::SetOpIterationEvent< T >::SetOpIterationEvent().

---

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

• freSetupOptimizationEvents.h

---