Class to create a Base wrapper around an object of a certain template type. More...

#include <mlITKMLBaseWrapper.h>

Public Member Functions
	ITKMLBaseWrapper (const WrapperSuperStructPtrs &parentSuperStruct, ITKWrapperBase &realWrapper)
	Constructor. More...

virtual	~ITKMLBaseWrapper ()
	Destructor. More...

void	addOutputBaseField (Module &module, const char *outputFieldName)
	Method to add a base field to the passed Module module. More...

void	addInputBaseField (Module &module, const char *inputFieldName)
	Method to add a base field to the passed Module module. More...

void	setNewOutputBaseFieldObject (OBJ_TYPE_POINTER newObject)
	Set base field so that it points to the new object. More...

BaseField *	getOutputBaseField ()
	Return the pointer to the output base field or NULL if not created. More...

BaseField *	getInputBaseField ()
	Return the pointer to the input base field or NULL if not created. More...

OBJ_TYPE_POINTER	getWrappedOutputObject ()
	Return the pointer to the wrapped object. More...

bool	hasSuperClass (const std::string &className) const
	Return true if the passed parent class name is in the list of classes. More...

OBJ_TYPE_POINTER	getWrappedInputObject (const RuntimeType *=NULL)

Protected Attributes
Base &	_realWrapper
	Reference to the real wrapper object creating this. More...

const WrapperSuperStructPtrs *	_wrapperSuperStructPtrs
	Reference to the inheritance pointer correlated to this class. More...

BaseField *	_outputBaseField
	Pointer to the field in _module which is used as output interface to another module; default is NULL. More...

BaseField *	_inputBaseField
	Pointer to the field in _module which is used as input interface to another module; default is NULL. More...

Module *	_module
	Pointer to the Module which shall handle this; default is NULL. More...

OBJ_TYPE_POINTER	_outputObj
	Smart pointer to the OBJ_TYPE created and wrapped by this class if an output connector is created. More...

OBJ_TYPE_POINTER	_inputObj
	Smart pointer to the connected OBJ_TYPE wrapped by this class if an input connector is created or NULL otherwise. More...

MLint	_numAddOutputBaseFieldCalls
	Counter for the number of addOutputBaseField method calls. More...

MLint	_numAddInputBaseFieldCalls
	Counter for the number of addInputBaseField method calls. More...

Detailed Description

template<class OBJ_TYPE, typename OBJ_TYPE_POINTER, typename WRAPPER_CLASS_NAME>
class ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >

Class to create a Base wrapper around an object of a certain template type.

Definition at line 60 of file mlITKMLBaseWrapper.h.

Constructor & Destructor Documentation

◆ ITKMLBaseWrapper()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::ITKMLBaseWrapper	(	const WrapperSuperStructPtrs &	parentSuperStruct,
		ITKWrapperBase &	realWrapper
	)

inline

Constructor.

Definition at line 67 of file mlITKMLBaseWrapper.h.

◆ ~ITKMLBaseWrapper()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

virtual ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::~ITKMLBaseWrapper ( )

inlinevirtual

Destructor.

Definition at line 82 of file mlITKMLBaseWrapper.h.

Member Function Documentation

◆ addInputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

void ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::addInputBaseField	(	Module &	module,
		const char *	inputFieldName
	)

inline

Method to add a base field to the passed Module module.

The value of the BaseField will be initialized to this. This method should be called only once.

Definition at line 117 of file mlITKMLBaseWrapper.h.

References ml::FieldContainer::addBase(), ML_BAD_POINTER_OR_0, ML_BAD_STATE, ML_PRINT_ERROR, and ml::BaseField::setBaseValue().

◆ addOutputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

void ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::addOutputBaseField	(	Module &	module,
		const char *	outputFieldName
	)

inline

Method to add a base field to the passed Module module.

The value of the BaseField will be initialized to this if createdObject is passed as true (the default). This method should be called only once, otherwise errors will be posted and the call will be ignored.

Definition at line 95 of file mlITKMLBaseWrapper.h.

References ml::FieldContainer::addBase(), ML_BAD_POINTER_OR_0, ML_BAD_STATE, ML_PRINT_ERROR, and ml::BaseField::setBaseValue().

◆ getInputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::getInputBaseField ( )

inline

Return the pointer to the input base field or NULL if not created.

Definition at line 154 of file mlITKMLBaseWrapper.h.

◆ getOutputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::getOutputBaseField ( )

inline

Return the pointer to the output base field or NULL if not created.

Definition at line 146 of file mlITKMLBaseWrapper.h.

◆ getWrappedInputObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::getWrappedInputObject ( const RuntimeType * = NULL )

inline

Return the pointer to the wrapped input object if it's of type of the

Runtime type, otherwise NULL is returned. If rt is passed as NULL

then for the Runtime Type of this is checked.

Definition at line 190 of file mlITKMLBaseWrapper.h.

References ML_BASE_IS_A.

◆ getWrappedOutputObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::getWrappedOutputObject ( )

inline

Return the pointer to the wrapped object.

Definition at line 162 of file mlITKMLBaseWrapper.h.

◆ hasSuperClass()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

bool ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::hasSuperClass ( const std::string & className ) const

inline

Return true if the passed parent class name is in the list of classes.

Definition at line 170 of file mlITKMLBaseWrapper.h.

References ml::WrapperSuperStructPtrs::nameStrings, and ml::WrapperSuperStructPtrs::parentSuperStruct.

◆ setNewOutputBaseFieldObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

void ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::setNewOutputBaseFieldObject ( OBJ_TYPE_POINTER newObject )

inline

Set base field so that it points to the new object.

Definition at line 137 of file mlITKMLBaseWrapper.h.

Member Data Documentation

◆ _inputBaseField

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_inputBaseField

protected

Pointer to the field in _module which is used as input interface to another module; default is NULL.

Definition at line 231 of file mlITKMLBaseWrapper.h.

◆ _inputObj

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_inputObj

protected

Smart pointer to the connected OBJ_TYPE wrapped by this class if an input connector is created or NULL otherwise.

Definition at line 242 of file mlITKMLBaseWrapper.h.

◆ _module

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

Module* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_module

protected

Pointer to the Module which shall handle this; default is NULL.

Definition at line 234 of file mlITKMLBaseWrapper.h.

◆ _numAddInputBaseFieldCalls

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

MLint ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_numAddInputBaseFieldCalls

protected

Counter for the number of addInputBaseField method calls.

More than on call will be ignored and lead to an ML_ERROR. Default is 0.

Definition at line 250 of file mlITKMLBaseWrapper.h.

◆ _numAddOutputBaseFieldCalls

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

MLint ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_numAddOutputBaseFieldCalls

protected

Counter for the number of addOutputBaseField method calls.

More than on call will be ignored and lead to an ML_ERROR. Default is 0.

Definition at line 246 of file mlITKMLBaseWrapper.h.

◆ _outputBaseField

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_outputBaseField

protected

Pointer to the field in _module which is used as output interface to another module; default is NULL.

Definition at line 227 of file mlITKMLBaseWrapper.h.

◆ _outputObj

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_outputObj

protected

Smart pointer to the OBJ_TYPE created and wrapped by this class if an output connector is created.

Definition at line 238 of file mlITKMLBaseWrapper.h.

◆ _realWrapper

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

Base& ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_realWrapper

protected

Reference to the real wrapper object creating this.

Definition at line 220 of file mlITKMLBaseWrapper.h.

◆ _wrapperSuperStructPtrs

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

const WrapperSuperStructPtrs* ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::_wrapperSuperStructPtrs

protected

Reference to the inheritance pointer correlated to this class.

Definition at line 223 of file mlITKMLBaseWrapper.h.

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

MeVisLab/ITK/Sources/ML/MLITKSupport/mlITKMLBaseWrapper.h

Public Member Functions

Protected Attributes

Detailed Description

template<class OBJ_TYPE, typename OBJ_TYPE_POINTER, typename WRAPPER_CLASS_NAME> class ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >

Constructor & Destructor Documentation

◆ ITKMLBaseWrapper()

◆ ~ITKMLBaseWrapper()

Member Function Documentation

◆ addInputBaseField()

◆ addOutputBaseField()

◆ getInputBaseField()

◆ getOutputBaseField()

◆ getWrappedInputObject()

◆ getWrappedOutputObject()

◆ hasSuperClass()

◆ setNewOutputBaseFieldObject()

Member Data Documentation

◆ _inputBaseField

◆ _inputObj

◆ _module

◆ _numAddInputBaseFieldCalls

◆ _numAddOutputBaseFieldCalls

◆ _outputBaseField

◆ _outputObj

◆ _realWrapper

◆ _wrapperSuperStructPtrs

template<class OBJ_TYPE, typename OBJ_TYPE_POINTER, typename WRAPPER_CLASS_NAME>
class ml::ITKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >