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

#include <mlVTKMLBaseWrapper.h>

Public Member Functions
	VTKMLBaseWrapper (const WrapperSuperStructPtrs &parentSuperStruct, VTKWrapperBase &realWrapper)
	Constructor. More...

virtual	~VTKMLBaseWrapper ()
	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::VTKMLBaseWrapper< 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 61 of file mlVTKMLBaseWrapper.h.

Constructor & Destructor Documentation

◆ VTKMLBaseWrapper()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

ml::VTKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >::VTKMLBaseWrapper	(	const WrapperSuperStructPtrs &	parentSuperStruct,
		VTKWrapperBase &	realWrapper
	)

inline

Constructor.

Definition at line 68 of file mlVTKMLBaseWrapper.h.

◆ ~VTKMLBaseWrapper()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

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

inlinevirtual

Destructor.

Definition at line 83 of file mlVTKMLBaseWrapper.h.

Member Function Documentation

◆ addInputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

void ml::VTKMLBaseWrapper< 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 118 of file mlVTKMLBaseWrapper.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::VTKMLBaseWrapper< 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 96 of file mlVTKMLBaseWrapper.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::VTKMLBaseWrapper< 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 155 of file mlVTKMLBaseWrapper.h.

◆ getOutputBaseField()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::VTKMLBaseWrapper< 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 147 of file mlVTKMLBaseWrapper.h.

◆ getWrappedInputObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::VTKMLBaseWrapper< 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 191 of file mlVTKMLBaseWrapper.h.

References ML_BASE_IS_A.

◆ getWrappedOutputObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

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

inline

Return the pointer to the wrapped object.

Definition at line 163 of file mlVTKMLBaseWrapper.h.

◆ hasSuperClass()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

bool ml::VTKMLBaseWrapper< 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 171 of file mlVTKMLBaseWrapper.h.

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

◆ setNewOutputBaseFieldObject()

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

void ml::VTKMLBaseWrapper< 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 138 of file mlVTKMLBaseWrapper.h.

Member Data Documentation

◆ _inputBaseField

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::VTKMLBaseWrapper< 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 232 of file mlVTKMLBaseWrapper.h.

◆ _inputObj

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::VTKMLBaseWrapper< 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 243 of file mlVTKMLBaseWrapper.h.

◆ _module

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

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

protected

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

Definition at line 235 of file mlVTKMLBaseWrapper.h.

◆ _numAddInputBaseFieldCalls

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

MLint ml::VTKMLBaseWrapper< 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 251 of file mlVTKMLBaseWrapper.h.

◆ _numAddOutputBaseFieldCalls

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

MLint ml::VTKMLBaseWrapper< 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 247 of file mlVTKMLBaseWrapper.h.

◆ _outputBaseField

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

BaseField* ml::VTKMLBaseWrapper< 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 228 of file mlVTKMLBaseWrapper.h.

◆ _outputObj

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

OBJ_TYPE_POINTER ml::VTKMLBaseWrapper< 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 239 of file mlVTKMLBaseWrapper.h.

◆ _realWrapper

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

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

protected

Reference to the real wrapper object creating this.

Definition at line 221 of file mlVTKMLBaseWrapper.h.

◆ _wrapperSuperStructPtrs

template<class OBJ_TYPE , typename OBJ_TYPE_POINTER , typename WRAPPER_CLASS_NAME >

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

protected

Reference to the inheritance pointer correlated to this class.

Definition at line 224 of file mlVTKMLBaseWrapper.h.

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

MeVisLab/VTK/Sources/ML/MLVTKSupport/mlVTKMLBaseWrapper.h

Public Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ VTKMLBaseWrapper()

◆ ~VTKMLBaseWrapper()

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::VTKMLBaseWrapper< OBJ_TYPE, OBJ_TYPE_POINTER, WRAPPER_CLASS_NAME >