MeVisLab Toolbox Reference
Public Member Functions | Protected Attributes | List of all members
ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME > Class Template Reference

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

#include <mlITKMLBaseWrapper.h>

Public Member Functions

 ITKTypedPointerWrapper ()
 Constructor.
 
void addOutputBaseField (Module &module, const char *outputFieldName)
 Method to add a base field to the passed Module module.
 
void addInputBaseField (Module &module, const char *inputFieldName)
 Method to add a base field to the passed Module module.
 
void setNewOutputBaseFieldObject (OBJ_TYPE::Pointer newObject)
 Set base field so that it points to the new object.
 
BaseField * getOutputBaseField ()
 For legacy reasons there are two fields for getting the base field.
 
BaseField * getInputBaseField ()
 For legacy reasons there are two fields for getting the base field.
 
OBJ_TYPE::Pointer getWrappedOutputObject ()
 Return the pointer to the wrapped object.
 
OBJ_TYPE::Pointer getWrappedInputObject ()
 Return the pointer to the wrapped input object, if it is of the correct type, otherwise a nullptr.
 

Protected Attributes

WRAPPER_CLASS_NAME _baseWrapper
 Reference to the Base object wrapping the ITK object pointer.
 
BaseField * _baseField = nullptr
 Pointer to the MLBaseField in _module.
 

Detailed Description

template<typename OBJ_TYPE, typename WRAPPER_CLASS_NAME>
class ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >

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

Definition at line 59 of file mlITKMLBaseWrapper.h.

Constructor & Destructor Documentation

◆ ITKTypedPointerWrapper()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::ITKTypedPointerWrapper ( )
inline

Constructor.

Definition at line 65 of file mlITKMLBaseWrapper.h.

Member Function Documentation

◆ addInputBaseField()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
void ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::addInputBaseField ( Module &  module,
const char *  inputFieldName 
)
inline

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

Will not set a pointer to a Base object.

Definition at line 94 of file mlITKMLBaseWrapper.h.

References ML_BAD_POINTER_OR_0, ML_BAD_STATE, and ML_PRINT_ERROR.

◆ addOutputBaseField()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
void ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::addOutputBaseField ( Module &  module,
const char *  outputFieldName 
)
inline

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

Will set the pointer to the embedded Base object.

Definition at line 73 of file mlITKMLBaseWrapper.h.

References ML_BAD_POINTER_OR_0, ML_BAD_STATE, and ML_PRINT_ERROR.

◆ getInputBaseField()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
BaseField * ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::getInputBaseField ( )
inline

For legacy reasons there are two fields for getting the base field.

Definition at line 132 of file mlITKMLBaseWrapper.h.

◆ getOutputBaseField()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
BaseField * ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::getOutputBaseField ( )
inline

For legacy reasons there are two fields for getting the base field.

Definition at line 124 of file mlITKMLBaseWrapper.h.

◆ getWrappedInputObject()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
OBJ_TYPE::Pointer ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::getWrappedInputObject ( )
inline

Return the pointer to the wrapped input object, if it is of the correct type, otherwise a nullptr.

Definition at line 149 of file mlITKMLBaseWrapper.h.

◆ getWrappedOutputObject()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
OBJ_TYPE::Pointer ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::getWrappedOutputObject ( )
inline

Return the pointer to the wrapped object.

Definition at line 140 of file mlITKMLBaseWrapper.h.

◆ setNewOutputBaseFieldObject()

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
void ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::setNewOutputBaseFieldObject ( OBJ_TYPE::Pointer  newObject)
inline

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

Definition at line 113 of file mlITKMLBaseWrapper.h.

Member Data Documentation

◆ _baseField

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
BaseField* ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::_baseField = nullptr
protected

Pointer to the MLBaseField in _module.

Definition at line 169 of file mlITKMLBaseWrapper.h.

◆ _baseWrapper

template<typename OBJ_TYPE , typename WRAPPER_CLASS_NAME >
WRAPPER_CLASS_NAME ml::ITKTypedPointerWrapper< OBJ_TYPE, WRAPPER_CLASS_NAME >::_baseWrapper
protected

Reference to the Base object wrapping the ITK object pointer.

Definition at line 166 of file mlITKMLBaseWrapper.h.

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