ITK  6.0.0
Insight 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>

Detailed Description

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

Implementation of the Command Pattern to be invoked every iteration

Definition at line 33 of file itkCommandIterationUpdate.h.

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

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using OptimizerType = TOptimizer
 
using Pointer = itk::SmartPointer< Self >
 
using Self = CommandIterationUpdate
 
using Superclass = itk::Command
 
- Public Types inherited from itk::Command
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Command
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

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

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CommandIterationUpdate ()=default
 
- 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (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
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

ConstSmart pointer type alias support

Definition at line 57 of file itkCommandIterationUpdate.h.

◆ OptimizerType

template<typename TOptimizer >
using itk::CommandIterationUpdate< TOptimizer >::OptimizerType = TOptimizer

Type defining the optimizer

Definition at line 107 of file itkCommandIterationUpdate.h.

◆ Pointer

template<typename TOptimizer >
using itk::CommandIterationUpdate< TOptimizer >::Pointer = itk::SmartPointer<Self>

Smart pointer type alias support

Definition at line 52 of file itkCommandIterationUpdate.h.

◆ Self

template<typename TOptimizer >
using itk::CommandIterationUpdate< TOptimizer >::Self = CommandIterationUpdate

Standard "Self" typedef.

Definition at line 40 of file itkCommandIterationUpdate.h.

◆ Superclass

template<typename TOptimizer >
using itk::CommandIterationUpdate< TOptimizer >::Superclass = itk::Command

Standard "Superclass" typedef.

Definition at line 46 of file itkCommandIterationUpdate.h.

Constructor & Destructor Documentation

◆ CommandIterationUpdate()

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

Constructor

Member Function Documentation

◆ Execute() [1/2]

template<typename TOptimizer >
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 69 of file itkCommandIterationUpdate.h.

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

◆ Execute() [2/2]

template<typename TOptimizer >
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 63 of file itkCommandIterationUpdate.h.

References itk::CommandIterationUpdate< TOptimizer >::Execute().

Referenced by itk::CommandIterationUpdate< TOptimizer >::Execute().

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

◆ New()

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

Method for creation through the object factory.

◆ SetOptimizer()

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

Member Data Documentation

◆ m_Optimizer

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

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