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::MemberCommand< T > Class Template Reference

#include <itkCommand.h>

Detailed Description

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

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

MemberCommand calls a pointer to a member function with the same arguments as Execute on Command.

Definition at line 86 of file itkCommand.h.

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

Public Types

using Pointer = SmartPointer< Self >
 
using Self = MemberCommand
 
using TMemberFunctionPointer = void(T::*)(Object *, const EventObject &)
 
using TConstMemberFunctionPointer = void(T::*)(const Object *, const EventObject &)
 
- 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

 itkOverrideGetNameOfClassMacro (MemberCommand)
 
void SetCallbackFunction (T *object, TConstMemberFunctionPointer memberFunction)
 
void SetCallbackFunction (T *object, TMemberFunctionPointer memberFunction)
 
void Execute (Object *caller, const EventObject &event) override
 
void Execute (const Object *caller, const EventObject &event) 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

 MemberCommand ()=default
 
 ~MemberCommand () 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

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

Member Typedef Documentation

◆ Pointer

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

Definition at line 98 of file itkCommand.h.

◆ Self

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

Standard class type aliases.

Definition at line 97 of file itkCommand.h.

◆ TConstMemberFunctionPointer

template<typename T >
using itk::MemberCommand< T >::TConstMemberFunctionPointer = void (T::*)(const Object *, const EventObject &)

pointer to a member function that takes a Object* and the event

Definition at line 93 of file itkCommand.h.

◆ TMemberFunctionPointer

template<typename T >
using itk::MemberCommand< T >::TMemberFunctionPointer = void (T::*)(Object *, const EventObject &)

pointer to a member function that takes a Object* and the event

Definition at line 92 of file itkCommand.h.

Constructor & Destructor Documentation

◆ MemberCommand()

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

◆ ~MemberCommand()

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

Member Function Documentation

◆ Execute() [1/2]

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

Invoke the member function with a const object.

Implements itk::Command.

Definition at line 135 of file itkCommand.h.

◆ Execute() [2/2]

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

Invoke the member function.

Implements itk::Command.

Definition at line 124 of file itkCommand.h.

◆ itkOverrideGetNameOfClassMacro()

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

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ SetCallbackFunction() [1/2]

template<typename T >
void itk::MemberCommand< T >::SetCallbackFunction ( T *  object,
TConstMemberFunctionPointer  memberFunction 
)
inline

Definition at line 116 of file itkCommand.h.

◆ SetCallbackFunction() [2/2]

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

Set the callback function along with the object that it will be invoked on.

Definition at line 109 of file itkCommand.h.

Member Data Documentation

◆ m_ConstMemberFunction

template<typename T >
TConstMemberFunctionPointer itk::MemberCommand< T >::m_ConstMemberFunction { nullptr }
protected

Definition at line 147 of file itkCommand.h.

◆ m_MemberFunction

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

Definition at line 146 of file itkCommand.h.

◆ m_This

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

Definition at line 145 of file itkCommand.h.


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