ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::CommandVnlIterationUpdate< TOptimizer > Class Template Reference

#include <itkCommandVnlIterationUpdate.h>

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

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using OptimizerType = TOptimizer
 
using Pointer = itk::SmartPointer< Self >
 
using Self = CommandVnlIterationUpdate
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void Execute (const itk::Object *, const itk::EventObject &event) override
 
void Execute (itk::Object *caller, const itk::EventObject &event) override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
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 ()
 
WeakPointer< OptimizerTypem_Optimizer
 
void SetOptimizer (OptimizerType *optimizer)
 
 CommandVnlIterationUpdate ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Command
 Command ()
 
 ~Command () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

Implementation of the Command Pattern to be invoked every iteration

Definition at line 33 of file itkCommandVnlIterationUpdate.h.

Member Typedef Documentation

◆ ConstPointer

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

ConstSmart pointer type alias support

Definition at line 57 of file itkCommandVnlIterationUpdate.h.

◆ OptimizerType

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

Type defining the optimizer

Definition at line 109 of file itkCommandVnlIterationUpdate.h.

◆ Pointer

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

Smart pointer type alias support

Definition at line 52 of file itkCommandVnlIterationUpdate.h.

◆ Self

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

Standard "Self" typedef.

Definition at line 40 of file itkCommandVnlIterationUpdate.h.

◆ Superclass

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

Standard "Superclass" typedef.

Definition at line 46 of file itkCommandVnlIterationUpdate.h.

Constructor & Destructor Documentation

◆ CommandVnlIterationUpdate()

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

Constructor

Member Function Documentation

◆ CreateAnother()

template<typename TOptimizer >
virtual::itk::LightObject::Pointer itk::CommandVnlIterationUpdate< 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.

◆ Execute() [1/2]

template<typename TOptimizer >
void itk::CommandVnlIterationUpdate< 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 itkCommandVnlIterationUpdate.h.

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

◆ Execute() [2/2]

template<typename TOptimizer >
void itk::CommandVnlIterationUpdate< 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 itkCommandVnlIterationUpdate.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

◆ New()

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

Method for creation through the object factory.

◆ SetOptimizer()

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

Member Data Documentation

◆ m_Optimizer

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

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