Implementation of the Command Pattern to be invoked every iteration. More...

#include <mlITKCommandIterationUpdate.h>

Inheritance diagram for ml::ITKCommandIterationUpdate:

Public Types
typedef ITKCommandIterationUpdate	Self
	Standard Self typedef.

typedef itk::Command	Superclass
	Standard "Superclass" typedef.

typedef itk::SmartPointer< Self >	Pointer
	Smart pointer typedef support.

typedef itk::SmartPointer< const Self >	ConstPointer
	ConstSmart pointer typedef support.

Public Member Functions
	itkTypeMacro (ITKCommandIterationUpdate, ::itk::Command)
	Run-time type information (and related methods).

	itkNewMacro (Self)
	Method for creation through the object factory.

void	setObject (itk::Object *object)
	Set object to be observed.

void	setStringField (StringField *strField)
	Set string field to be updated on object changes.

StringField *	getStringField () const
	Get string field to be updated on object changes or NULL if no field is set.

void	setEndEventField (Field *strField)
	Set field to be notified on EndEvents.

Field *	getEndEventField () const
	Get field to be notified on EndEvents or NULL if no field is set.

void	reset ()
	Reset update state.

Protected Member Functions
	ITKCommandIterationUpdate ()
	Constructor. Purposely implemented protected.

	~ITKCommandIterationUpdate ()
	Destructor. Purposely implemented protected.

void	Execute (itk::Object *obj, const itk::EventObject &event) override
	Wrapper call to the const version.

void	Execute (const itk::Object *obj, const itk::EventObject &event) override
	Gets object state and updates _stringField with process information if stringField is valid.

Detailed Description

Implementation of the Command Pattern to be invoked every iteration.

Definition at line 25 of file mlITKCommandIterationUpdate.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> ml::ITKCommandIterationUpdate::ConstPointer

ConstSmart pointer typedef support.

Definition at line 39 of file mlITKCommandIterationUpdate.h.

◆ Pointer

typedef itk::SmartPointer<Self> ml::ITKCommandIterationUpdate::Pointer

Smart pointer typedef support.

Definition at line 36 of file mlITKCommandIterationUpdate.h.

◆ Self

typedef ITKCommandIterationUpdate ml::ITKCommandIterationUpdate::Self

Standard Self typedef.

Definition at line 30 of file mlITKCommandIterationUpdate.h.

◆ Superclass

typedef itk::Command ml::ITKCommandIterationUpdate::Superclass

Standard "Superclass" typedef.

Definition at line 33 of file mlITKCommandIterationUpdate.h.

Constructor & Destructor Documentation

◆ ITKCommandIterationUpdate()

ml::ITKCommandIterationUpdate::ITKCommandIterationUpdate ( )

protected

Constructor. Purposely implemented protected.

◆ ~ITKCommandIterationUpdate()

ml::ITKCommandIterationUpdate::~ITKCommandIterationUpdate ( )

protected

Destructor. Purposely implemented protected.

Member Function Documentation

◆ Execute() [1/2]

void ml::ITKCommandIterationUpdate::Execute	(	const itk::Object *	obj,
		const itk::EventObject &	event )

overrideprotected

Gets object state and updates _stringField with process information if stringField is valid.

◆ Execute() [2/2]

void ml::ITKCommandIterationUpdate::Execute	(	itk::Object *	obj,
		const itk::EventObject &	event )

overrideprotected

Wrapper call to the const version.

◆ getEndEventField()

Field * ml::ITKCommandIterationUpdate::getEndEventField ( ) const

Get field to be notified on EndEvents or NULL if no field is set.

◆ getStringField()

StringField * ml::ITKCommandIterationUpdate::getStringField ( ) const

Get string field to be updated on object changes or NULL if no field is set.

◆ itkNewMacro()

ml::ITKCommandIterationUpdate::itkNewMacro ( Self )

Method for creation through the object factory.

◆ itkTypeMacro()

ml::ITKCommandIterationUpdate::itkTypeMacro	(	ITKCommandIterationUpdate	,
		::itk::Command	)

Run-time type information (and related methods).

◆ reset()

void ml::ITKCommandIterationUpdate::reset ( )

Reset update state.

◆ setEndEventField()

void ml::ITKCommandIterationUpdate::setEndEventField ( Field * strField )

Set field to be notified on EndEvents.

Replacing the string field or resetting it to NULL is legal.

◆ setObject()

void ml::ITKCommandIterationUpdate::setObject ( itk::Object * object )

Set object to be observed.

Resetting the object to NULL or replacement by a new one is legal.

◆ setStringField()

void ml::ITKCommandIterationUpdate::setStringField ( StringField * strField )

Set string field to be updated on object changes.