itk::FunctionCommand Class Reference

#include <itkCommand.h>

Detailed Description

A Command subclass that calls a std::function object.

This function object is suitable to accept C++ lambda functions.

Definition at line 427 of file itkCommand.h.

Inheritance diagram for itk::FunctionCommand:

Collaboration diagram for itk::FunctionCommand:

Public Types
using	FunctionObjectType = std::function< void(const EventObject &)>
using	Pointer = SmartPointer< Self >
using	Self = FunctionCommand
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
void	Execute (const Object *, const EventObject &event) override
void	Execute (Object *, const EventObject &event) override
const char *	GetNameOfClass () const override
void	SetCallback (FunctionObjectType f)
virtual void	Execute (const Object *caller, const EventObject &event)=0
virtual void	Execute (Object *caller, const EventObject &event)=0
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
const char *	GetNameOfClass () const override
virtual const TimeStamp &	GetTimeStamp () 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) const
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 Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

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
	FunctionCommand ()
	~FunctionCommand () override
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	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
FunctionObjectType	m_FunctionObject {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

FunctionObjectType

using itk::FunctionCommand::FunctionObjectType = std::function<void(const EventObject &)>

Definition at line 434 of file itkCommand.h.

Pointer

using itk::FunctionCommand::Pointer = SmartPointer<Self>

Definition at line 432 of file itkCommand.h.

Self

using itk::FunctionCommand::Self = FunctionCommand

Standard class type aliases.

Definition at line 431 of file itkCommand.h.

Constructor & Destructor Documentation

FunctionCommand()

itk::FunctionCommand::FunctionCommand ( )

protected

~FunctionCommand()

itk::FunctionCommand::~FunctionCommand ( )

overrideprotected

Member Function Documentation

Execute() [1/2]

void itk::FunctionCommand::Execute ( const Object *  , const EventObject &  event  )

overridevirtual

Execute the callback function with a const Object

Implements itk::Command.

Execute() [2/2]

void itk::FunctionCommand::Execute ( Object *  , const EventObject &  event  )

overridevirtual

Execute the callback function.

Implements itk::Command.

GetNameOfClass()

const char * itk::FunctionCommand::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::Command.

New()

static Pointer itk::FunctionCommand::New ( )

static

Method for creation through the object factory.

SetCallback()

void itk::FunctionCommand::SetCallback

(

FunctionObjectType

f

)

Set the C callback function pointer to be called at Execute time.

Member Data Documentation

m_FunctionObject

FunctionObjectType itk::FunctionCommand::m_FunctionObject {}

protected

Definition at line 459 of file itkCommand.h.

---

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

• itkCommand.h