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

#include <itkCommand.h>

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

Public Types

using Pointer = SmartPointer< Self >
 
using Self = ReceptorMemberCommand
 
using TMemberFunctionPointer = void(T::*)(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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void SetCallbackFunction (T *object, TMemberFunctionPointer memberFunction)
 
- 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
 
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
 
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 ()
 
T * m_This
 
TMemberFunctionPointer m_MemberFunction
 
void Execute (Object *, const EventObject &event) override
 
void Execute (const Object *, const EventObject &event) override
 
 ReceptorMemberCommand ()
 
 ~ReceptorMemberCommand () override=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 &timeStamp)
 
- 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 T>
class itk::ReceptorMemberCommand< T >

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

ReceptorMemberCommand calls a pointer to a member function with only and itk::EventObject as argument

Definition at line 168 of file itkCommand.h.

Member Typedef Documentation

◆ Pointer

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

Definition at line 178 of file itkCommand.h.

◆ Self

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

Standard class type aliases.

Definition at line 177 of file itkCommand.h.

◆ TMemberFunctionPointer

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

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

Definition at line 174 of file itkCommand.h.

Constructor & Destructor Documentation

◆ ReceptorMemberCommand()

template<typename T >
itk::ReceptorMemberCommand< T >::ReceptorMemberCommand ( )
inlineprotected

Invoke the member function.

Definition at line 221 of file itkCommand.h.

◆ ~ReceptorMemberCommand()

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

Invoke the member function.

Member Function Documentation

◆ CreateAnother()

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

◆ Execute() [1/2]

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

Invoke the member function with a const object

Implements itk::Command.

Definition at line 208 of file itkCommand.h.

◆ Execute() [2/2]

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

Invoke the member function.

Implements itk::Command.

Definition at line 197 of file itkCommand.h.

◆ GetNameOfClass()

template<typename T >
virtual const char* itk::ReceptorMemberCommand< T >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Command.

◆ New()

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

Method for creation through the object factory.

◆ SetCallbackFunction()

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

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

Definition at line 189 of file itkCommand.h.

Member Data Documentation

◆ m_MemberFunction

template<typename T >
TMemberFunctionPointer itk::ReceptorMemberCommand< T >::m_MemberFunction
protected

Invoke the member function.

Definition at line 219 of file itkCommand.h.

◆ m_This

template<typename T >
T* itk::ReceptorMemberCommand< T >::m_This
protected

Invoke the member function.

Definition at line 218 of file itkCommand.h.


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