FREE::ProgressCtrlEvent< T > Class Template Reference

#include <freControllerEvents.h>

Inheritance diagram for FREE::ProgressCtrlEvent< T >:

[legend]

Collaboration diagram for FREE::ProgressCtrlEvent< T >:

[legend]

List of all members.

Public Types
typedef void(T::*	ProgEvent )(const IDPath &senderID, const StatusID status, const std::string &sComment, SessionComponentCache *pSender, long threadID)
typedef ProgressCtrlEvent< T >	Self
typedef itk::SmartPointer < Self >	Pointer
Public Member Functions
	freNewEventMacro (ProgressCtrlEvent, T, ProgEvent)
virtual const char *	GetNameOfClass () const
virtual void	Execute (const IDPath &senderID, const StatusID status, const std::string &sComment, SessionComponentCache *pSender, long threadID=0)
Protected Member Functions
	ProgressCtrlEvent (T *pObject, ProgEvent pPE)
Private Member Functions
	ProgressCtrlEvent (const Self &)
void	operator= (const Self &)
Private Attributes
T *	m_Object
ProgEvent	m_ProgressEvent

---

Detailed Description

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

Definition at line 280 of file freControllerEvents.h.

---

Member Typedef Documentation

template<typename T>

typedef void(T::* FREE::ProgressCtrlEvent< T >::ProgEvent)(const IDPath &senderID, const StatusID status, const std::string &sComment, SessionComponentCache *pSender, long threadID)

Reimplemented from FREE::ProgressCtrlEventBase.

Definition at line 283 of file freControllerEvents.h.

template<typename T>

typedef ProgressCtrlEvent<T> FREE::ProgressCtrlEvent< T >::Self

Reimplemented from FREE::ProgressCtrlEventBase.

Definition at line 289 of file freControllerEvents.h.

template<typename T>

typedef itk::SmartPointer<Self> FREE::ProgressCtrlEvent< T >::Pointer

Reimplemented from FREE::ProgressCtrlEventBase.

Definition at line 290 of file freControllerEvents.h.

---

Constructor & Destructor Documentation

template<typename T>

FREE::ProgressCtrlEvent< T >::ProgressCtrlEvent

(

const Self &

)

[private]

template<typename T>

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

Definition at line 303 of file freControllerEvents.h.

References FREE::ProgressCtrlEvent< T >::m_Object, and FREE::ProgressCtrlEvent< T >::m_ProgressEvent.

---

Member Function Documentation

template<typename T>

FREE::ProgressCtrlEvent< T >::freNewEventMacro	(	ProgressCtrlEvent< T >	,
		T	,
		ProgEvent
	)

template<typename T>

virtual const char* FREE::ProgressCtrlEvent< T >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::ProgressCtrlEventBase.

Definition at line 293 of file freControllerEvents.h.

template<typename T>

void FREE::ProgressCtrlEvent< T >::operator=

(

const Self &

)

[private]

Reimplemented from FREE::ProgressCtrlEventBase.

template<typename T>

virtual void FREE::ProgressCtrlEvent< T >::Execute	(	const IDPath &	senderID,
		const StatusID	status,
		const std::string &	sComment,
		SessionComponentCache *	pSender,
		long	threadID = 0
	)			[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]	senderID	IDPath of the component that notifies a progress.
[in]	status	ID of the current status of progress.
[in]	sComment	String for adding any comments concerning the new status.
[in,out]	pSender	Pointer to the session component cache that was active when the event was executed.
[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.

Definition at line 321 of file freControllerEvents.h.

References FREE::ProgressCtrlEventBase::m_ExecutionMutex, FREE::ProgressCtrlEvent< T >::m_Object, and FREE::ProgressCtrlEvent< T >::m_ProgressEvent.

---

Member Data Documentation

template<typename T>

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

Definition at line 293 of file freControllerEvents.h.

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

template<typename T>

ProgEvent FREE::ProgressCtrlEvent< T >::m_ProgressEvent [private]

Reimplemented from FREE::ProgressCtrlEventBase.

Definition at line 297 of file freControllerEvents.h.

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

---

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

• freControllerEvents.h

---