ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::SimpleConstMemberCommand< T > Class Template Reference

#include <itkCommand.h>

Detailed Description

template<typename T>
class itk::SimpleConstMemberCommand< T >

A Command subclass that calls a pointer to a member function.

SimpleConstMemberCommand calls a pointer to a member function with no arguments.

Definition at line 297 of file itkCommand.h.

+ Inheritance diagram for itk::SimpleConstMemberCommand< T >:
+ Collaboration diagram for itk::SimpleConstMemberCommand< T >:

Public Types

using Pointer = SmartPointer< Self >
 
using Self = SimpleConstMemberCommand
 
using TMemberFunctionPointer = void(T::*)() const
 
- 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 Object *, const EventObject &) override
 
 itkOverrideGetNameOfClassMacro (SimpleConstMemberCommand)
 
void SetCallbackFunction (const T *object, TMemberFunctionPointer memberFunction)
 
void Execute (Object *, const EventObject &) override
 
- Public Member Functions inherited from itk::Command
 itkOverrideGetNameOfClassMacro (Command)
 
- 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
 
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
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 SimpleConstMemberCommand ()=default
 
 ~SimpleConstMemberCommand () override=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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

TMemberFunctionPointer m_MemberFunction { nullptr }
 
const T * m_This { nullptr }
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ Pointer

template<typename T >
using itk::SimpleConstMemberCommand< T >::Pointer = SmartPointer<Self>

Definition at line 307 of file itkCommand.h.

◆ Self

template<typename T >
using itk::SimpleConstMemberCommand< T >::Self = SimpleConstMemberCommand

Standard class type aliases.

Definition at line 306 of file itkCommand.h.

◆ TMemberFunctionPointer

template<typename T >
using itk::SimpleConstMemberCommand< T >::TMemberFunctionPointer = void (T::*)() const

A const member method callback.

Definition at line 303 of file itkCommand.h.

Constructor & Destructor Documentation

◆ SimpleConstMemberCommand()

template<typename T >
itk::SimpleConstMemberCommand< T >::SimpleConstMemberCommand ( )
protecteddefault

◆ ~SimpleConstMemberCommand()

template<typename T >
itk::SimpleConstMemberCommand< T >::~SimpleConstMemberCommand ( )
overrideprotecteddefault

Member Function Documentation

◆ Execute() [1/2]

template<typename T >
void itk::SimpleConstMemberCommand< T >::Execute ( const Object caller,
const 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 335 of file itkCommand.h.

◆ Execute() [2/2]

template<typename T >
void itk::SimpleConstMemberCommand< T >::Execute ( Object ,
const EventObject  
)
inlineoverridevirtual

Invoke the const member method callback.

Implements itk::Command.

Definition at line 325 of file itkCommand.h.

◆ itkOverrideGetNameOfClassMacro()

template<typename T >
itk::SimpleConstMemberCommand< T >::itkOverrideGetNameOfClassMacro ( SimpleConstMemberCommand< T >  )

Run-time type information (and related methods).

◆ New()

template<typename T >
static Pointer itk::SimpleConstMemberCommand< T >::New ( )
static

Method for creation through the object factory.

◆ SetCallbackFunction()

template<typename T >
void itk::SimpleConstMemberCommand< T >::SetCallbackFunction ( const T *  object,
TMemberFunctionPointer  memberFunction 
)
inline

Specify the const member method callback.

Definition at line 317 of file itkCommand.h.

Member Data Documentation

◆ m_MemberFunction

template<typename T >
TMemberFunctionPointer itk::SimpleConstMemberCommand< T >::m_MemberFunction { nullptr }
protected

Definition at line 345 of file itkCommand.h.

◆ m_This

template<typename T >
const T* itk::SimpleConstMemberCommand< T >::m_This { nullptr }
protected

Definition at line 344 of file itkCommand.h.


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