SimpleITK  2.1.0.dev109
Public Member Functions | Protected Member Functions | Friends | List of all members
itk::simple::Command Class Reference

An implementation of the Command design pattern for callback. More...

#include <sitkCommand.h>

+ Inheritance diagram for itk::simple::Command:
+ Collaboration diagram for itk::simple::Command:

Public Member Functions

 Command ()
 Default Constructor. More...
 
virtual void Execute ()
 
std::string GetName () const override
 
void SetName (const std::string &n) override
 
virtual ~Command () override
 
- Public Member Functions inherited from itk::simple::ObjectOwnedBase
 ObjectOwnedBase ()=default
 
virtual ~ObjectOwnedBase ()=0
 
- Public Member Functions inherited from itk::simple::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 

Protected Member Functions

virtual size_t AddProcessObject (itk::simple::ProcessObject *o)
 
virtual size_t RemoveProcessObject (const itk::simple::ProcessObject *o)
 
- Protected Member Functions inherited from itk::simple::ObjectOwnedBase
virtual size_t AddObjectCallback (itk::Object *o, std::function< void()> onDelete)
 Register an Object and a method to call on this object's destructor. More...
 
 ObjectOwnedBase (const ObjectOwnedBase &o)
 Copy Constructor. More...
 
virtual size_t RemoveObject (const itk::Object *)
 
virtual void SetOwnedByObjects (bool o)
 
virtual bool GetOwnedByObjects () const
 
virtual void OwnedByObjectsOn ()
 
virtual void OwnedByObjectsOff ()
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 

Friends

class itk::simple::ProcessObject
 

Detailed Description

An implementation of the Command design pattern for callback.

This class provides a callback mechanism for event that occur from the ProcessObject. These commands can be utilized to observe these events.

The Command can be created on the stack, and will automatically unregistered it's self when destroyed.

For more information see the page CommandPage.

Examples
DemonsRegistration1/DemonsRegistration1.cxx, DemonsRegistration2/DemonsRegistration2.cxx, FilterProgressReporting/FilterProgressReporting.cxx, ImageRegistrationMethod1/ImageRegistrationMethod1.cxx, ImageRegistrationMethod2/ImageRegistrationMethod2.cxx, ImageRegistrationMethodBSpline1/ImageRegistrationMethodBSpline1.cxx, ImageRegistrationMethodBSpline3/ImageRegistrationMethodBSpline3.cxx, and ImageRegistrationMethodDisplacement1/ImageRegistrationMethodDisplacement1.cxx.

Definition at line 44 of file sitkCommand.h.

Constructor & Destructor Documentation

◆ Command()

itk::simple::Command::Command ( )

Default Constructor.

◆ ~Command()

virtual itk::simple::Command::~Command ( )
overridevirtual

Destructor.

Member Function Documentation

◆ AddProcessObject()

virtual size_t itk::simple::Command::AddProcessObject ( itk::simple::ProcessObject o)
protectedvirtual

◆ Execute()

virtual void itk::simple::Command::Execute ( )
virtual

◆ GetName()

std::string itk::simple::Command::GetName ( ) const
overridevirtual

Set/Get Command Name

Reimplemented from itk::simple::ObjectOwnedBase.

◆ RemoveProcessObject()

virtual size_t itk::simple::Command::RemoveProcessObject ( const itk::simple::ProcessObject o)
protectedvirtual

◆ SetName()

void itk::simple::Command::SetName ( const std::string &  name)
overridevirtual

Get object name.

Reimplemented from itk::simple::ObjectOwnedBase.

Friends And Related Function Documentation

◆ itk::simple::ProcessObject

friend class itk::simple::ProcessObject
friend

Definition at line 64 of file sitkCommand.h.


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