itk::Command Class Reference

#include <itkCommand.h>

Inheritance diagram for itk::Command:

Collaboration diagram for itk::Command:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Command	Self
typedef Object	Superclass
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	Execute (Object *caller, const EventObject &event)=0
virtual void	Execute (const Object *caller, const EventObject &event)=0
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
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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

Protected Member Functions
	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
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 ()

Private Member Functions
	Command (const Self &)
void	operator= (const Self &)

Additional Inherited Members
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 ()

---

Detailed Description

Superclass for callback/observer methods.

Command is an implementation of the command design pattern that is used in callbacks (such as StartMethod(), ProgressMethod(), and EndMethod()) in ITK. itk::Object implements a Subject/Observer pattern. When a subject needs to notify a observer, it does so using a itk::Command. The Execute method is called to run the command.

Wiki Examples:

• All Examples

• Observe an event

Definition at line 44 of file itkCommand.h.

---

Member Typedef Documentation

typedef SmartPointer< const Self > itk::Command::ConstPointer

Reimplemented from itk::Object.

Reimplemented in itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

Definition at line 51 of file itkCommand.h.

typedef SmartPointer< Self > itk::Command::Pointer

Reimplemented from itk::Object.

Reimplemented in itk::CStyleCommand, itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, itk::MemberCommand< T >, itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

Definition at line 50 of file itkCommand.h.

typedef Command itk::Command::Self

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::CStyleCommand, itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, itk::MemberCommand< T >, itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

Definition at line 48 of file itkCommand.h.

typedef Object itk::Command::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

Definition at line 49 of file itkCommand.h.

---

Constructor & Destructor Documentation

itk::Command::Command ( )

protected

itk::Command::~Command ( )

protected

itk::Command::Command ( const Self &  )

private

---

Member Function Documentation

virtual void itk::Command::Execute ( Object *  caller, const EventObject &  event  )

pure virtual

Abstract method that defines the action to be taken by the command.

Implemented in itk::CStyleCommand, itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, itk::MemberCommand< T >, itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

virtual void itk::Command::Execute ( const Object *  caller, const EventObject &  event  )

pure virtual

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

Implemented in itk::CStyleCommand, itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, itk::MemberCommand< T >, itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

virtual const char* itk::Command::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::CStyleCommand, itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, itk::MemberCommand< T >, itk::CommandIterationUpdate< TOptimizer >, itk::CommandVnlIterationUpdate< TOptimizer >, and itk::WatershedMiniPipelineProgressCommand.

void itk::Command::operator= ( const Self &  )

private

Reimplemented in itk::SimpleConstMemberCommand< T >, itk::SimpleMemberCommand< T >, itk::ReceptorMemberCommand< T >, and itk::MemberCommand< T >.

---

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

• itkCommand.h