ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::MemberCommand< T > Class Template Reference

#include <itkCommand.h>

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

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 85 of file itkCommand.h.

Public Types

typedef SmartPointer< SelfPointer
 
typedef MemberCommand Self
 
typedef void(T::* TMemberFunctionPointer )(Object *, const EventObject &)
 
typedef void(T::* TConstMemberFunctionPointer )(const Object *, const EventObject &)
 
- Public Types inherited from itk::Command
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Command Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void SetCallbackFunction (T *object, TMemberFunctionPointer memberFunction)
 
void SetCallbackFunction (T *object, TConstMemberFunctionPointer memberFunction)
 
virtual void Execute (Object *caller, const EventObject &event) override
 
virtual void Execute (const Object *caller, const EventObject &event) override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 ()
 

Protected Member Functions

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

Private Member Functions

 MemberCommand (const Self &)
 
void operator= (const Self &)
 

Member Typedef Documentation

template<typename T >
typedef SmartPointer< Self > itk::MemberCommand< T >::Pointer

Definition at line 96 of file itkCommand.h.

template<typename T >
typedef MemberCommand itk::MemberCommand< T >::Self

Standard class typedefs.

Definition at line 95 of file itkCommand.h.

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

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

Definition at line 90 of file itkCommand.h.

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

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

Definition at line 89 of file itkCommand.h.

Constructor & Destructor Documentation

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

Definition at line 145 of file itkCommand.h.

template<typename T >
virtual itk::MemberCommand< T >::~MemberCommand ( )
inlineprotectedvirtual

Definition at line 151 of file itkCommand.h.

template<typename T >
itk::MemberCommand< T >::MemberCommand ( const Self )
private

Member Function Documentation

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

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

Invoke the member function.

Implements itk::Command.

Definition at line 121 of file itkCommand.h.

References itk::MemberCommand< T >::m_MemberFunction.

template<typename T >
virtual 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 131 of file itkCommand.h.

References itk::MemberCommand< T >::m_ConstMemberFunction.

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

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

Method for creation through the object factory.

template<typename T >
void itk::MemberCommand< T >::operator= ( const Self )
private
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 106 of file itkCommand.h.

References itk::MemberCommand< T >::m_MemberFunction, and itk::MemberCommand< T >::m_This.

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

Member Data Documentation

template<typename T >
TConstMemberFunctionPointer itk::MemberCommand< T >::m_ConstMemberFunction
protected
template<typename T >
TMemberFunctionPointer itk::MemberCommand< T >::m_MemberFunction
protected
template<typename T >
T* itk::MemberCommand< T >::m_This
protected

Definition at line 141 of file itkCommand.h.

Referenced by itk::MemberCommand< T >::SetCallbackFunction().


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