ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::FunctionCommand Class Reference

#include <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

virtual ::itk::LightObject::Pointer CreateAnother () const
void Execute (const Object *, const EventObject &event) override
void Execute (Object *, const EventObject &event) override
virtual const char * GetNameOfClass () const
void SetCallback (FunctionObjectType f)
- 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 ()

Protected Member Functions

 FunctionCommand ()
 ~FunctionCommand () override
- 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

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

Detailed Description

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

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

Definition at line 440 of file itkCommand.h.

Member Typedef Documentation

◆ FunctionObjectType

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

Definition at line 447 of file itkCommand.h.

◆ Pointer

Definition at line 445 of file itkCommand.h.

◆ Self

Standard class type aliases.

Definition at line 444 of file itkCommand.h.

Constructor & Destructor Documentation

◆ FunctionCommand()

itk::FunctionCommand::FunctionCommand ( )

◆ ~FunctionCommand()

itk::FunctionCommand::~FunctionCommand ( )

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::FunctionCommand::CreateAnother ( ) const

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]

void itk::FunctionCommand::Execute ( const Object ,
const EventObject event 

Execute the callback function with a const Object

Implements itk::Command.

◆ Execute() [2/2]

void itk::FunctionCommand::Execute ( Object ,
const EventObject event 

Execute the callback function.

Implements itk::Command.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

◆ New()

static Pointer itk::FunctionCommand::New ( )

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

Definition at line 472 of file itkCommand.h.

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