MeVisLab Toolbox Reference
ml::ITKCommandIterationUpdate Class Reference

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. More...
 
typedef itk::Command Superclass
 Standard "Superclass" typedef. More...
 
typedef itk::SmartPointer< SelfPointer
 Smart pointer typedef support. More...
 
typedef itk::SmartPointer< const SelfConstPointer
 ConstSmart pointer typedef support. More...
 

Public Member Functions

 itkTypeMacro (ITKCommandIterationUpdate, ::itk::Command)
 Run-time type information (and related methods). More...
 
 itkNewMacro (Self)
 Method for creation through the object factory. More...
 
void setObject (itk::Object *object)
 Set object to be observed. More...
 
void setStringField (StringField *strField)
 Set string field to be updated on object changes. More...
 
StringFieldgetStringField () const
 Get string field to be updated on object changes or NULL if no field is set. More...
 
void setEndEventField (Field *strField)
 Set field to be notified on EndEvents. More...
 
FieldgetEndEventField () const
 Get field to be notified on EndEvents or NULL if no field is set. More...
 
void reset ()
 Reset update state. More...
 

Protected Member Functions

 ITKCommandIterationUpdate ()
 Constructor. Purposely implemented protected. More...
 
 ~ITKCommandIterationUpdate ()
 Destructor. Purposely implemented protected. More...
 
void Execute (itk::Object *obj, const itk::EventObject &event) override
 Wrapper call to the const version. More...
 
void Execute (const itk::Object *obj, const itk::EventObject &event) override
 Gets object state and updates _stringField with process information if stringField is valid. More...
 

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

Standard Self typedef.

Definition at line 30 of file mlITKCommandIterationUpdate.h.

◆ 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.

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


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