ITK  4.3.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 357 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 (void) const
 
virtual const char * GetNameOfClass () const
 
void SetClientData (void *cd)
 
void SetClientDataDeleteCallback (DeleteDataFunctionPointer f)
 
void SetCallback (FunctionPointer f)
 
void SetConstCallback (ConstFunctionPointer f)
 
void Execute (Object *caller, const EventObject &event)
 
void Execute (const Object *caller, const EventObject &event)
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

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

Typedefs for C-style callbacks.

Definition at line 362 of file itkCommand.h.

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

Typedefs for C-style callbacks.

Definition at line 364 of file itkCommand.h.

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

Typedefs for C-style callbacks.

Definition at line 361 of file itkCommand.h.

Definition at line 369 of file itkCommand.h.

Standard class typedefs.

Definition at line 368 of file itkCommand.h.

Constructor & Destructor Documentation

itk::CStyleCommand::CStyleCommand ( )
inlineprotected

Definition at line 413 of file itkCommand.h.

itk::CStyleCommand::~CStyleCommand ( )
inlineprotected

Definition at line 419 of file itkCommand.h.

References m_ClientData, and m_ClientDataDeleteCallback.

Member Function Documentation

virtual::itk::LightObject::Pointer itk::CStyleCommand::CreateAnother ( void  ) 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.

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

Execute the callback function.

Implements itk::Command.

Definition at line 393 of file itkCommand.h.

References m_Callback, and m_ClientData.

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

Execute the callback function with a const Object

Implements itk::Command.

Definition at line 403 of file itkCommand.h.

References m_ClientData, and m_ConstCallback.

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

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

Definition at line 382 of file itkCommand.h.

References m_Callback.

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

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

Definition at line 379 of file itkCommand.h.

References m_ClientData.

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

Set the callback to delete the client data.

Definition at line 389 of file itkCommand.h.

References m_ClientDataDeleteCallback.

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

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

Definition at line 384 of file itkCommand.h.

References m_ConstCallback.

Member Data Documentation

FunctionPointer itk::CStyleCommand::m_Callback
protected

Definition at line 428 of file itkCommand.h.

Referenced by Execute(), and SetCallback().

void* itk::CStyleCommand::m_ClientData
protected

Definition at line 427 of file itkCommand.h.

Referenced by Execute(), SetClientData(), and ~CStyleCommand().

DeleteDataFunctionPointer itk::CStyleCommand::m_ClientDataDeleteCallback
protected

Definition at line 430 of file itkCommand.h.

Referenced by SetClientDataDeleteCallback(), and ~CStyleCommand().

ConstFunctionPointer itk::CStyleCommand::m_ConstCallback
protected

Definition at line 429 of file itkCommand.h.

Referenced by Execute(), and SetConstCallback().


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