Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::CStyleCommand Class Reference
[ITK System Objects]

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

#include <itkCommand.h>

Inheritance diagram for itk::CStyleCommand:

Inheritance graph
[legend]
Collaboration diagram for itk::CStyleCommand:

Collaboration graph
[legend]
List of all members.

Public Types

typedef CStyleCommand Self
typedef SmartPointer< SelfPointer
typedef void(* FunctionPointer )(Object *, const EventObject &, void *)
typedef void(* ConstFunctionPointer )(const Object *, const EventObject &, void *)
typedef void(* DeleteDataFunctionPointer )(void *)

Public Member Functions

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

Pointer New ()

Protected Member Functions

 CStyleCommand ()
 ~CStyleCommand ()

Protected Attributes

void * m_ClientData
FunctionPointer m_Callback
ConstFunctionPointer m_ConstCallback
DeleteDataFunctionPointer m_ClientDataDeleteCallback

Detailed Description

Command subclass that calls a pointer to a C function.

CStyleCommand

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.


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

typedef SmartPointer<Self> itk::CStyleCommand::Pointer
 

Reimplemented from itk::Command.

Definition at line 368 of file itkCommand.h.

typedef CStyleCommand itk::CStyleCommand::Self
 

Standard class typedefs.

Reimplemented from itk::Command.

Definition at line 367 of file itkCommand.h.


Constructor & Destructor Documentation

itk::CStyleCommand::CStyleCommand  )  [inline, protected]
 

Definition at line 412 of file itkCommand.h.

itk::CStyleCommand::~CStyleCommand  )  [inline, protected]
 

Definition at line 416 of file itkCommand.h.


Member Function Documentation

void itk::CStyleCommand::Execute const Object caller,
const EventObject event
[inline, virtual]
 

Execute the callback function with a const Object

Implements itk::Command.

Definition at line 402 of file itkCommand.h.

References m_ClientData, and m_ClientDataDeleteCallback.

void itk::CStyleCommand::Execute Object caller,
const EventObject event
[inline, virtual]
 

Execute the callback function.

Implements itk::Command.

Definition at line 392 of file itkCommand.h.

virtual const char* itk::CStyleCommand::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::Command.

Pointer itk::CStyleCommand::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::CStyleCommand::SetCallback FunctionPointer  f  )  [inline]
 

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

Definition at line 381 of file itkCommand.h.

References m_Callback, and m_ClientData.

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

References m_Callback.

void itk::CStyleCommand::SetClientDataDeleteCallback DeleteDataFunctionPointer  f  )  [inline]
 

Set the callback to delete the client data.

Definition at line 388 of file itkCommand.h.

References m_ClientData, and m_ConstCallback.

void itk::CStyleCommand::SetConstCallback ConstFunctionPointer  f  )  [inline]
 

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

Definition at line 383 of file itkCommand.h.


Member Data Documentation

FunctionPointer itk::CStyleCommand::m_Callback [protected]
 

Definition at line 424 of file itkCommand.h.

Referenced by SetCallback(), and SetClientData().

void* itk::CStyleCommand::m_ClientData [protected]
 

Definition at line 423 of file itkCommand.h.

Referenced by Execute(), SetCallback(), and SetClientDataDeleteCallback().

DeleteDataFunctionPointer itk::CStyleCommand::m_ClientDataDeleteCallback [protected]
 

Definition at line 426 of file itkCommand.h.

Referenced by Execute().

ConstFunctionPointer itk::CStyleCommand::m_ConstCallback [protected]
 

Definition at line 425 of file itkCommand.h.

Referenced by SetClientDataDeleteCallback().


The documentation for this class was generated from the following file:
Generated at Thu May 25 00:43:19 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000