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

#include <itkCommand.h>

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 364 of file itkCommand.h.

+ Inheritance diagram for itk::CStyleCommand:
+ Collaboration diagram for itk::CStyleCommand:

Public Types

using Pointer = SmartPointer< Self >
 
using Self = CStyleCommand
 
using FunctionPointer = void(*)(Object *, const EventObject &, void *)
 
using ConstFunctionPointer = void(*)(const Object *, const EventObject &, void *)
 
using DeleteDataFunctionPointer = void(*)(void *)
 
- 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 *caller, const EventObject &event) override
 
void Execute (Object *caller, const EventObject &event) override
 
 itkOverrideGetNameOfClassMacro (CStyleCommand)
 
void SetClientData (void *cd)
 
void SetClientDataDeleteCallback (DeleteDataFunctionPointer f)
 
void SetCallback (FunctionPointer f)
 
void SetConstCallback (ConstFunctionPointer f)
 
- Public Member Functions inherited from itk::Command
 itkOverrideGetNameOfClassMacro (Command)
 
- 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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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

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

Protected Attributes

FunctionPointer m_Callback { nullptr }
 
void * m_ClientData { nullptr }
 
DeleteDataFunctionPointer m_ClientDataDeleteCallback { nullptr }
 
ConstFunctionPointer m_ConstCallback { nullptr }
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstFunctionPointer

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

Typedefs for C-style callbacks.

Definition at line 369 of file itkCommand.h.

◆ DeleteDataFunctionPointer

Typedefs for C-style callbacks.

Definition at line 370 of file itkCommand.h.

◆ FunctionPointer

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

Typedefs for C-style callbacks.

Definition at line 368 of file itkCommand.h.

◆ Pointer

Definition at line 375 of file itkCommand.h.

◆ Self

Standard class type aliases.

Definition at line 374 of file itkCommand.h.

Constructor & Destructor Documentation

◆ CStyleCommand()

itk::CStyleCommand::CStyleCommand ( )
protected

◆ ~CStyleCommand()

itk::CStyleCommand::~CStyleCommand ( )
overrideprotected

Member Function Documentation

◆ 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.

◆ itkOverrideGetNameOfClassMacro()

itk::CStyleCommand::itkOverrideGetNameOfClassMacro ( CStyleCommand  )

Run-time type information (and related methods).

◆ 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)

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

Member Data Documentation

◆ m_Callback

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

Definition at line 412 of file itkCommand.h.

◆ m_ClientData

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

Definition at line 411 of file itkCommand.h.

◆ m_ClientDataDeleteCallback

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

Definition at line 414 of file itkCommand.h.

◆ m_ConstCallback

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

Definition at line 413 of file itkCommand.h.


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