ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::CommandIterationUpdate< TOptimizer > Class Template Reference

#include <itkCommandIterationUpdate.h>

+ Inheritance diagram for itk::CommandIterationUpdate< TOptimizer >:
+ Collaboration diagram for itk::CommandIterationUpdate< TOptimizer >:

Detailed Description

template<typename TOptimizer>
class itk::CommandIterationUpdate< TOptimizer >

Implementation of the Command Pattern to be invoked every iteration

Definition at line 32 of file itkCommandIterationUpdate.h.

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TOptimizer OptimizerType
 
typedef itk::SmartPointer< SelfPointer
 
typedef CommandIterationUpdate Self
 
typedef itk::Command Superclass
 
- Public Types inherited from itk::Command
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Command Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void Execute (itk::Object *caller, const itk::EventObject &event) override
 
virtual void Execute (const itk::Object *, const itk::EventObject &event) override
 
virtual const char * GetNameOfClass () const
 
void SetOptimizer (OptimizerType *optimizer)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CommandIterationUpdate ()
 
- Protected Member Functions inherited from itk::Command
 Command ()
 
 ~Command () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

WeakPointer< OptimizerTypem_Optimizer
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TOptimizer >
typedef itk::SmartPointer<const Self> itk::CommandIterationUpdate< TOptimizer >::ConstPointer

ConstSmart pointer typedef support.

Definition at line 56 of file itkCommandIterationUpdate.h.

template<typename TOptimizer >
typedef TOptimizer itk::CommandIterationUpdate< TOptimizer >::OptimizerType

Type defining the optimizer

Definition at line 104 of file itkCommandIterationUpdate.h.

template<typename TOptimizer >
typedef itk::SmartPointer<Self> itk::CommandIterationUpdate< TOptimizer >::Pointer

Smart pointer typedef support.

Definition at line 51 of file itkCommandIterationUpdate.h.

template<typename TOptimizer >
typedef CommandIterationUpdate itk::CommandIterationUpdate< TOptimizer >::Self

Standard "Self" typedef.

Definition at line 39 of file itkCommandIterationUpdate.h.

template<typename TOptimizer >
typedef itk::Command itk::CommandIterationUpdate< TOptimizer >::Superclass

Standard "Superclass" typedef.

Definition at line 45 of file itkCommandIterationUpdate.h.

Constructor & Destructor Documentation

template<typename TOptimizer >
itk::CommandIterationUpdate< TOptimizer >::CommandIterationUpdate ( )
inlineprotected

Constructor

Definition at line 128 of file itkCommandIterationUpdate.h.

Member Function Documentation

template<typename TOptimizer >
virtual::itk::LightObject::Pointer itk::CommandIterationUpdate< TOptimizer >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TOptimizer >
virtual void itk::CommandIterationUpdate< TOptimizer >::Execute ( itk::Object caller,
const itk::EventObject event 
)
inlineoverridevirtual

Execute method will print data at each iteration

Implements itk::Command.

Definition at line 61 of file itkCommandIterationUpdate.h.

template<typename TOptimizer >
virtual void itk::CommandIterationUpdate< TOptimizer >::Execute ( const itk::Object caller,
const itk::EventObject event 
)
inlineoverridevirtual

Abstract method that defines the action to be taken by the command. This variant is expected to be used when requests comes from a const Object

Implements itk::Command.

Definition at line 66 of file itkCommandIterationUpdate.h.

References itk::CommandIterationUpdate< TOptimizer >::m_Optimizer.

template<typename TOptimizer >
virtual const char* itk::CommandIterationUpdate< TOptimizer >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Command.

template<typename TOptimizer >
static Pointer itk::CommandIterationUpdate< TOptimizer >::New ( )
static

Method for creation through the object factory.

template<typename TOptimizer >
void itk::CommandIterationUpdate< TOptimizer >::SetOptimizer ( OptimizerType optimizer)
inline

Member Data Documentation

template<typename TOptimizer >
WeakPointer<OptimizerType> itk::CommandIterationUpdate< TOptimizer >::m_Optimizer
private

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