MeVisLabToolboxReference
ml::MLITKObjectFactory Class Reference

A class to manage a void pointer to an object of a certain class type a type dataType and dimension dim. More...

#include <mlITKObjectFactory.h>

List of all members.

Public Types

typedef void *(* MLITKObjectFactoryCreator )(MLDataType dataType, unsigned int dim)
 Function type to cerate an object and to return a void pointer to it.
typedef void(* MLITKObjectFactoryDestructor )(void *, MLDataType dataType, unsigned int dim)
 Function type to destroy an object.

Public Member Functions

 MLITKObjectFactory ()
 Create an empty object.
 ~MLITKObjectFactory ()
 Destroy internally stored object.
void createObject (MLDataType dType, int dim)
 Create object.
void createObject (MLDataType dType, ImageVector v)
 Create object.
void destroyObject ()
 Destroy object.
void * getObject () const
 Returns void pointer to the managed internal object.
MLDataType getDataType () const
 Returns data type of the managed internal object.
int getDimension () const
 Returns dimension of the managed internal object.
void _setCreatorAndDestructor (MLITKObjectFactoryCreator cFunc, MLITKObjectFactoryDestructor dFunc)
 Sets creator and destructor functions. Only to be called by the macro.

Detailed Description

A class to manage a void pointer to an object of a certain class type a type dataType and dimension dim.

Using an instance of this class requires also the usage of the macros MLITKImplementFactoryFuncs and MLITKObjectFactoryInit.

Definition at line 126 of file mlITKObjectFactory.h.


Member Typedef Documentation

typedef void*(* ml::MLITKObjectFactory::MLITKObjectFactoryCreator)(MLDataType dataType, unsigned int dim)

Function type to cerate an object and to return a void pointer to it.

Definition at line 131 of file mlITKObjectFactory.h.

typedef void(* ml::MLITKObjectFactory::MLITKObjectFactoryDestructor)(void *, MLDataType dataType, unsigned int dim)

Function type to destroy an object.

Definition at line 134 of file mlITKObjectFactory.h.


Constructor & Destructor Documentation

ml::MLITKObjectFactory::MLITKObjectFactory ( ) [inline]

Create an empty object.

Definition at line 137 of file mlITKObjectFactory.h.

ml::MLITKObjectFactory::~MLITKObjectFactory ( ) [inline]

Destroy internally stored object.

Definition at line 140 of file mlITKObjectFactory.h.


Member Function Documentation

void ml::MLITKObjectFactory::_setCreatorAndDestructor ( MLITKObjectFactoryCreator  cFunc,
MLITKObjectFactoryDestructor  dFunc 
) [inline]

Sets creator and destructor functions. Only to be called by the macro.

Definition at line 161 of file mlITKObjectFactory.h.

void ml::MLITKObjectFactory::createObject ( MLDataType  dType,
ImageVector  v 
) [inline]

Create object.

Definition at line 146 of file mlITKObjectFactory.h.

void ml::MLITKObjectFactory::createObject ( MLDataType  dType,
int  dim 
) [inline]

Create object.

Definition at line 143 of file mlITKObjectFactory.h.

void ml::MLITKObjectFactory::destroyObject ( ) [inline]

Destroy object.

Definition at line 149 of file mlITKObjectFactory.h.

MLDataType ml::MLITKObjectFactory::getDataType ( void  ) const [inline]

Returns data type of the managed internal object.

Definition at line 155 of file mlITKObjectFactory.h.

int ml::MLITKObjectFactory::getDimension ( ) const [inline]

Returns dimension of the managed internal object.

Definition at line 158 of file mlITKObjectFactory.h.

void* ml::MLITKObjectFactory::getObject ( ) const [inline]

Returns void pointer to the managed internal object.

Definition at line 152 of file mlITKObjectFactory.h.


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