ITK  4.8.0
Insight Segmentation and Registration 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>

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

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.

Public Types

typedef SmartPointer< SelfPointer
 
typedef CStyleCommand Self
 
typedef void(* FunctionPointer )(Object *, const EventObject &, void *)
 
typedef void(* ConstFunctionPointer )(const Object *, const EventObject &, void *)
 
typedef void(* DeleteDataFunctionPointer )(void *)
 
- Public Types inherited from itk::Command
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Command Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void Execute (Object *caller, const EventObject &event) override
 
virtual void Execute (const Object *caller, const EventObject &event) override
 
virtual const char * GetNameOfClass () const
 
void SetClientData (void *cd)
 
void SetClientDataDeleteCallback (DeleteDataFunctionPointer f)
 
void SetCallback (FunctionPointer f)
 
void SetConstCallback (ConstFunctionPointer f)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CStyleCommand ()
 
 ~CStyleCommand ()
 
- Protected Member Functions inherited from itk::Command
 Command ()
 
 ~Command ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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
 
void * m_ClientData
 
DeleteDataFunctionPointer m_ClientDataDeleteCallback
 
ConstFunctionPointer m_ConstCallback
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Typedefs for C-style callbacks.

Definition at line 382 of file itkCommand.h.

typedef void( * itk::CStyleCommand::DeleteDataFunctionPointer)(void *)

Typedefs for C-style callbacks.

Definition at line 384 of file itkCommand.h.

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

Typedefs for C-style callbacks.

Definition at line 381 of file itkCommand.h.

Definition at line 389 of file itkCommand.h.

Standard class typedefs.

Definition at line 388 of file itkCommand.h.

Constructor & Destructor Documentation

itk::CStyleCommand::CStyleCommand ( )
protected
itk::CStyleCommand::~CStyleCommand ( )
protected

Member Function Documentation

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

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::Object.

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

Execute the callback function.

Implements itk::Command.

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

Execute the callback function with a const Object

Implements itk::Command.

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

Run-time type information (and related methods).

Reimplemented from itk::Command.

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

Method for creation through the object factory.

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

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

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

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

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

Set the callback to delete the client data.

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

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

Member Data Documentation

FunctionPointer itk::CStyleCommand::m_Callback
protected

Definition at line 420 of file itkCommand.h.

void* itk::CStyleCommand::m_ClientData
protected

Definition at line 419 of file itkCommand.h.

DeleteDataFunctionPointer itk::CStyleCommand::m_ClientDataDeleteCallback
protected

Definition at line 422 of file itkCommand.h.

ConstFunctionPointer itk::CStyleCommand::m_ConstCallback
protected

Definition at line 421 of file itkCommand.h.


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