ITK  5.2.0
Insight Toolkit
List of all members
itk::CStyleCommand Class Reference

#include <itkCommand.h>

+ Inheritance diagram for itk::CStyleCommand:
+ Collaboration diagram for itk::CStyleCommand:
using FunctionPointer = void(*)(Object *, const EventObject &, void *)
 
using ConstFunctionPointer = void(*)(const Object *, const EventObject &, void *)
 
using DeleteDataFunctionPointer = void(*)(void *)
 
using Self = CStyleCommand
 
using Pointer = SmartPointer< Self >
 
void * m_ClientData { nullptr }
 
FunctionPointer m_Callback { nullptr }
 
ConstFunctionPointer m_ConstCallback { nullptr }
 
DeleteDataFunctionPointer m_ClientDataDeleteCallback { nullptr }
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetClientData (void *cd)
 
void SetCallback (FunctionPointer f)
 
void SetConstCallback (ConstFunctionPointer f)
 
void SetClientDataDeleteCallback (DeleteDataFunctionPointer f)
 
void Execute (Object *caller, const EventObject &event) override
 
void Execute (const Object *caller, const EventObject &event) override
 
static Pointer New ()
 
 CStyleCommand ()
 
 ~CStyleCommand () override
 

Additional Inherited Members

- 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 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
- 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 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 &time)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

A Command subclass that calls a pointer to a C function.

CStyleCommand calls a pointer to a C function with the following arguments void func(Object *,void *clientdata) The clientdata is data that the command wants passed to itself each time.

Definition at line 377 of file itkCommand.h.

Member Typedef Documentation

◆ ConstFunctionPointer

using itk::CStyleCommand::ConstFunctionPointer = void (*)(const Object *, const EventObject &, void *)

Typedefs for C-style callbacks.

Definition at line 382 of file itkCommand.h.

◆ DeleteDataFunctionPointer

Typedefs for C-style callbacks.

Definition at line 383 of file itkCommand.h.

◆ FunctionPointer

using itk::CStyleCommand::FunctionPointer = void (*)(Object *, const EventObject &, void *)

Typedefs for C-style callbacks.

Definition at line 381 of file itkCommand.h.

◆ Pointer

Typedefs for C-style callbacks.

Definition at line 388 of file itkCommand.h.

◆ Self

Standard class type aliases.

Definition at line 387 of file itkCommand.h.

Constructor & Destructor Documentation

◆ CStyleCommand()

itk::CStyleCommand::CStyleCommand ( )
protected

Typedefs for C-style callbacks.

◆ ~CStyleCommand()

itk::CStyleCommand::~CStyleCommand ( )
overrideprotected

Typedefs for C-style callbacks.

Member Function Documentation

◆ CreateAnother()

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

Typedefs for C-style callbacks.

Reimplemented from itk::LightObject.

◆ Execute() [1/2]

void itk::CStyleCommand::Execute ( const Object caller,
const EventObject event 
)
overridevirtual

Execute the callback function with a const Object

Implements itk::Command.

◆ Execute() [2/2]

void itk::CStyleCommand::Execute ( Object caller,
const EventObject event 
)
overridevirtual

Execute the callback function.

Implements itk::Command.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

◆ New()

static Pointer itk::CStyleCommand::New ( )
static

Method for creation through the object factory.

◆ SetCallback()

void itk::CStyleCommand::SetCallback ( FunctionPointer  f)

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

◆ SetClientData()

void itk::CStyleCommand::SetClientData ( void *  cd)

Set the client data that will be passed into the C function when it is called.

◆ SetClientDataDeleteCallback()

void itk::CStyleCommand::SetClientDataDeleteCallback ( DeleteDataFunctionPointer  f)

Set the callback to delete the client data.

◆ SetConstCallback()

void itk::CStyleCommand::SetConstCallback ( ConstFunctionPointer  f)

Typedefs for C-style callbacks.

Member Data Documentation

◆ m_Callback

FunctionPointer itk::CStyleCommand::m_Callback { nullptr }
protected

Typedefs for C-style callbacks.

Definition at line 425 of file itkCommand.h.

◆ m_ClientData

void* itk::CStyleCommand::m_ClientData { nullptr }
protected

Typedefs for C-style callbacks.

Definition at line 424 of file itkCommand.h.

◆ m_ClientDataDeleteCallback

DeleteDataFunctionPointer itk::CStyleCommand::m_ClientDataDeleteCallback { nullptr }
protected

Typedefs for C-style callbacks.

Definition at line 427 of file itkCommand.h.

◆ m_ConstCallback

ConstFunctionPointer itk::CStyleCommand::m_ConstCallback { nullptr }
protected

Typedefs for C-style callbacks.

Definition at line 426 of file itkCommand.h.


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