Template module class ListContainerTemplate for a specific list class. More...

#include <mlListContainer.h>

Inheritance diagram for ml::ListContainerTemplate< T >:

Public Member Functions
	ListContainerTemplate (int inputNum, int outputNum)
	Constructor The values inputNum and outputNum specify the number of input and output image fields, resp.

	~ListContainerTemplate () override
	Destructor.

virtual T *	getList ()
	Get pointer to the active list object Use this pointer for list access after testing that it is != 0.

Public Member Functions inherited from ml::ListContainerBase
	ListContainerBase ()
	Constructor.

	ListContainerBase (ListBase *listBasePtr, int inputNum, int outputNum)
	Constructor In listBasePtr pass a pointer to the list object, which has to be a member of the derived class.

void	setHandleNotificationCB (ListContainerHandleNotificationCB cb=nullptr, void userData=nullptr)
	Set the callback for handleNotification.

BaseField *	getOutputField ()
	Returns a pointer to the output field.

MLint	maxNumItems () const

int	overflowMode () const
	Returns the overflow mode.

void	handleNotification (Field *field) override
	Called when any field data in the field container of this module is modified.

void	activateAttachments () override
	Update fields after an initialization without handleNotification() called.

void	beginSaveFields () override
	Prepare for persistence.

void	endSaveFields () override
	Clean up after persistence.

virtual void	doDeleteAll ()

virtual void	doDeleteItem (MLssize_t index)
	Delete single item at position index.

virtual void	doInsertItem (MLssize_t index, bool fromCurrentItem)
	Insert an item at position index.

virtual void	doModifyItem (MLssize_t index, Field *field, bool fromCurrentItem)
	Modify item at position index.

virtual void	doCopyItemToTemplate (MLssize_t index)
	Copy values from item at position index to the template fields.

virtual void	doClearItem (MLssize_t index)
	Init item at position index.

virtual void	doSelectItem (MLssize_t index)
	Select item at position index, or deselect if item == -1.

virtual void	doUpdate ()
	Update all fields and touch output list field.

Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the meta profile for the base operator.

const char *	getTypeNameFast () const
	Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h).

	Module (int numInputImages, int numOutputImages)
	Constructor: Initializes `numInputImages` input images and `numOutputImages` output images of the module.

	~Module () override
	Destructor: Destroys this module.

InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image `i`. `i` must be a valid index.

OutputConnectorField *	getOutputImageField (MLint i=0) const
	Returns field representing output image `i`. `i` must be a valid index.

MLint	getNumInputImages () const
	Returns number of input images of this module.

MLint	getNumOutputImages () const
	Returns number of output images of this module.

PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns output image `outputIndex`. The index needs to be in the range [0, getNumOutputImages()-1].

InputConnectorField *	addInputImage (const char *name=nullptr)
	Adds a new input image with `name` to the module.

OutputConnectorField *	addOutputImage (const char *name=nullptr)
	Adds a new output image with `name` to the module.

PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
	Returns the output image of the module connected to input `inputIndex`.

PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
	Convenience method for safe access to the input image at index `inputIndex`.

MLErrorCode	processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes all pages of a module for easy implementation of page-based image processing of complete images.

MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Process input images with a ProcessAllPagesHandler `handler` on a temporary output image (which allocates no data) For details, see processAllPages(-1) above.

MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes all missing pages on the given output image.

void	clearOutputImage (MLint i=0)
	Clear cached output image pages of output image `i`.

MLint	getOutputImageInplace (MLint outputIndex=0) const
	Return optimization flag: Return index of input image whose input tile is used also as output page for output `outputIndex` in calculateOutputSubImage() (instead of allocating its own memory).

MLint	getBypass (MLint outputIndex=0) const
	Returns the currently bypass index or -1 if bypassing is disabled (default).

THREAD_SUPPORT	getThreadSupport () const
	Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT.

bool	areRecursiveHandleNotificationsPermitted () const
	Returns if recursive entries in handleNotification are permitted.

MLint	getHandleNotificationEntryCounter () const
	A counter returning the current number of (recursive re)entries in handleNotification.

PERMITTED_TYPES	getVoxelDataTypeSupport () const
	Returns the current state of supported voxel data types.

bool	isSupportedVoxelDataType (MLDataType dt) const
	Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport.

virtual INPUT_HANDLE	handleInput (int, INPUT_STATE) const
	This method may be reimplemented to enable support for invalid input images on the module.

INPUT_STATE	getInputState (MLint index)
	Returns the current state of the input connection.

INPUT_STATE	getUpdatedInputState (MLint index)
	Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards.

bool	isInputImageField (Field *field) const
	Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed.

void	touchOutputImageFields () const
	Touch all output image fields to indicate that the images have changed.

Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.

	~FieldContainer () override
	Destructor: Deletes all added fields.

std::string	whoAmI (bool withInstanceName=true) const
	Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and `withInstanceName` is true.

Field *	addField (const char name, const char type, const char *value)
	Adds a new field with name `name`, type `type` and value `value` (coded as string) to the container.

Field *	addField (Field *field)
	Adds a `field`, the ownership of the field is passed to the FieldContainer.

BoolField *	addBool (const char *name)
	Creates a BoolField with `name` and adds it to the container. Default value is false.

BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with `name` and adds it to the container.

IntField *	addInt (const char *name)
	Creates an IntField with `name` and adds it to the container. Default value is 0.

IntField *	addInt (const char *name, MLint value)
	Creates an IntField with `name` and adds it to the container.

EnumField *	addEnum (const char name, const char const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with `name` and adds it to the container.

EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
	Creates an EnumField field with `name` and adds it to the container.

template<typename EnumType >
TypedEnumField< EnumType > *	addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
	Creates a TypedEnumField field with `name` and adds it to the container.

FloatField *	addFloat (const char *name)
	Creates a FloatField with `name` and adds it to the container. Default value is 0.f.

FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with `name` and adds it to the container.

ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with `name` and adds it to the container. Default value is 0.f.

ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with `name` and adds it to the container.

DoubleField *	addDouble (const char *name)
	Creates a DoubleField with `name` and adds it to the container. Default value is 0.

DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with `name` and adds it to the container.

StringField *	addString (const char *name)
	Creates a StringField with `name` and adds it to the container. Default value is empty string.

StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with `name` and adds it to the container.

NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with `name` and adds it to the container.

TriggerField *	addTrigger (const char *name)
	Creates a TriggerField field with `name` and adds it to the container.

BaseField *	addBase (const char *name)
	Creates a Base field with `name` and adds it to the container. Default value is NULL.

BaseField *	addBase (const char name, Base value)
	Creates a Base field with `name` and adds it to the container.

BaseField *	addBase (const char *name, const RefCountedBasePtr &value)
	Creates a Base field with `name` and adds it to the container. Sets the value from intrusive pointer.

template<typename T >
BaseField *	addBaseWithAllowedType (const char name, T value=nullptr)
	As above, but also sets the allowed type of the field.

template<typename T >
BaseField *	addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
	As above, but also sets the allowed type of the field.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name)
	Creates a TypedBaseField with `name` and adds it to the container. Default value is NULL.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char name, T value)
	Creates a TypedBaseField with `name` and adds it to the container.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
	Creates a TypedBaseField with `name` and adds it to the container. Sets the value from intrusive pointer.

SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with `name` and adds it to the container. Default value is NULL.

SoNodeField *	addSoNode (const char name, SoNode value)
	Creates a SoNodeField with `name` and adds it to the container.

PointerField *	addPointer (const char *name)
	Creates a PointerField with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
	Creates a ImageVectorField with `name` and adds it to the container.

SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with `name` and adds it to the container.

ColorField *	addColor (const char *name)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with `name` and adds it to the container.

RotationField *	addRotation (const char *name)
	Creates a RotationField with `name` and adds it to the container.

RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with `name` and adds it to the container.

UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with `name` and adds it to the container.

IntListField *	addIntList (const char *name)
	Creates an IntListField field with `name` and empty list value and adds it to the container.

IntListField *	addIntList (const char *name, const std::vector< MLint > &value)
	Creates an IntListField field with `name` and given list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with `name` and empty list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name, const std::vector< double > &value)
	Creates an DoubleListField field with `name` and given list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with `name` and empty list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name, const std::vector< Vector2 > &value)
	Creates an Vector2ListField field with `name` and given list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with `name` and empty list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name, const std::vector< Vector3 > &value)
	Creates an Vector3ListField field with `name` and given list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with `name` and empty list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name, const std::vector< Vector4 > &value)
	Creates an Vector4ListField field with `name` and given list value and adds it to the container.

size_t	getNumFields () const
	Returns the number of added fields.

bool	hasField (const std::string &name) const
	Returns true if the field with name `name` exists; otherwise false is returned.

Field *	getField (const std::string &name) const
	Returns the pointer to the field with name `name`.

Field *	getField (MLint index) const
	Returns pointer of field at `index` if it exists. If not, -1 is returned.

MLint	getFieldIndex (Field *field) const
	Returns index of `field` if it exists. If not, -1 is returned.

void	setFieldStringValue (const std::string &name, const std::string &value)
	Sets the `value` of the field with `name` if it exists.

std::string	getFieldStringValue (const std::string &name) const
	Returns the string value of the field with `name` if it is found.

virtual void	deactivateAttachments ()
	Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed.

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion()

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument.

virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Return a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`.

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object.

Public Attributes
T::itemType	_currentItem
	List item object used by insertItem() and modifyItem().

Protected Member Functions
List object access
bool	setActiveList (Base *basePtr) override
	Set the active list pointer _listPtr to basePtr, provided that it is of the correct type.

ListBase *	getInternalList () override
	Return address of internal list object.

MLssize_t	getId (MLssize_t index) override
	Return the item id of the item index.

Handle item property fields
Update property fields from the current list item
void	updatePropertyFields () override
	Update property fields from the current list item.

List modifications
Remove num items, starting at item index
void	deleteItems (MLssize_t index, MLssize_t num) override
	Remove num items, starting at item index.

void	insertItem (MLssize_t index, bool fromCurrentItem) override
	Insert an item at position index.

bool	modifyItem (MLssize_t index, Field *field, bool fromCurrentItem) override
	Modify item at position index.

void	copyItemToTemplate (MLssize_t index) override
	Copy values from item at position index to the template fields.

void	copyTemplateToCurrent () override
	Copy the values of the templates fields to _currentItem.

void	initItem (MLssize_t index) override
	Initialize the list item at position index.

Protected Member Functions inherited from ml::ListContainerBase
virtual bool	ownsList ()
	Return true if the active list is the internal list.

virtual bool	isPropertyField (Field *field)

virtual void	resetPropertyFields ()
	Reset all property fields.

virtual void	updateListString (bool forceEnable=false)

virtual void	updateDisplay ()
	Update display of list size, current item index and item properties.

virtual void	updateActionFields ()
	Update last action fields.

virtual void	touchList (ListBase::ActionClass actionClass, MLssize_t id, MLssize_t index)
	Set last list action and touch output list field.

Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
	Called from FieldContainer whenever a field changes.

virtual void	provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
	This method allows a Module to provide its own pages to the Host for the `outputIndex` output image.

void	handleNotificationOff ()
	Decreases lock counter for handleNotification calls.

void	handleNotificationOn ()
	Increases lock counter for handleNotification calls.

bool	isHandleNotificationOn ()
	Returns true if handleNotification calls are permitted, otherwise false.

void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
	Set optimization flag: If calculating a page in calculateOutputSubImage(), the output image page of output `outputIndex` shall use the same memory as the input page of input `inputIndex`.

void	unsetOutputImageInplace (MLint outputIndex=0)
	Clear optimization flag: output page of output at `outputIndex` and input tile shall use different memory buffers in calculateOutputSubImage().

void	setBypass (MLint outputIndex=0, MLint inputIndex=0)
	Sets the input image whose pages can also be used instead of output pages for the output image at `outputIndex` to avoid recalculations.

void	setClampPagesToImageExtent (bool flag=true)
	Enables/disables page clamping on all output images.

void	setThreadSupport (THREAD_SUPPORT supportMode)
	Pass any THREAD_SUPPORT `supportMode` to decide whether and what type of multithreading is supported by this module.

void	permitRecursiveHandleNotifications (bool enable)
	If this flag is set to `enable` =true, recursive entries in handleNotification are permitted.

void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
	Specifies which types this module supports.

virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
	Creates the CalculateOutputImageHandler for the given output image `outputImage`.

virtual void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage)
	Set properties of output image `outputImage` with output index `outputIndex`.

virtual SubImageBox	calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
	Called by the Host to determine which input image region (tile) of input `inputIndex` is required to calculate a certain output image region (page) of output `outputIndex`.

virtual void	calculateOutputSubImage (SubImage outputSubImage, int outputIndex, SubImage inputSubImages)
	Calculate page `outputSubImage` of output image with index `outputIndex` given the input image tiles in array `inputSubImages`.

Protected Attributes
T *	_listPtr
	Pointer to the active list object Use this pointer for list access after testing that it is != 0.

Protected Attributes inherited from ml::ListContainerBase
int	_lockNotification
	Suppress handleNotification() if non-zero.

BaseField *	_fldOutputList
	Output list field, initialized by derived class.

BaseField *	_fldInputList
	Input list field, initialized by derived class.

StringField *	_fldListString
	String representation of list.

IntField *	_fldNumItems
	List size.

IntField *	_fldIndex
	Current list index.

BoolField *	_fldPersistent
	Activate internal list persistence.

BoolField *	_fldListStringEnable
	Enable list string field.

BoolField *	_fldOwnsList
	Reflect owner state (true if internal list is active)

BoolField *	_fldApplySelect
	Perform a Select-action when index is changed.

IntField *	_fldId
	List item id.

StringField *	_fldName
	List item name.

StringField *	_fldNewName
	List item name.

StringField *	_fldActionClass
	Action class of last action on list.

IntField *	_fldActionIndex
	Index of last action on list.

IntField *	_fldActionId
	Item id of last action on list.

IntField *	_fldCurrentIndex
	Index of currently selected item.

EnumField *	_fldOverflowMode
	Overflow mode, specifies which item(s) to delete on overflow.

IntField *	_fldMaxSize
	Maximum list size.

NotifyField *	_fldDelete
	Delete button.

NotifyField *	_fldDeleteAll
	Delete All button.

NotifyField *	_fldInsert
	Insert button.

NotifyField *	_fldAdd
	Add (= Append) button.

NotifyField *	_fldUpdate
	Update button.

BoolField *	_fldUseInsertTemplate
	If true the container should use the template fields for initializing the inserted item.

NotifyField *	_fldCopyItemToTemplate
	Copy values from current item to template fields.

NotifyField *	_fldCopyTemplateToItem
	Copy values from template fields to current item.

NotifyField *	_fldClearItem
	Clear the current item (i.e. init it again).

BoolField *	_fldUpToDate
	Indicates that the property values are up to date.

Additional Inherited Members
Public Types inherited from ml::ListContainerBase
enum	OverflowModes { OvwNone = 0 , OvwRemoveFirst , OvwRemoveLast , OvwRemoveAll , OvwRemoveNew , OvwNumModes }
	Mode constants for cases of list size overflow. More...

Public Types inherited from ml::Module
enum	PERMITTED_TYPES { ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES }
	See documentation of setVoxelDataTypeSupport. More...

enum	INPUT_STATE { DISCONNECTED = 0 , CONNECTED_BUT_INVALID = 1 , CONNECTED_AND_VALID = 2 , CONNECTED_BUT_NEEDS_UPDATE = 3 }
	See documentation of handleInput. More...

enum	INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
	See documentation of handleInput. More...

Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Static Public Member Functions inherited from ml::Module
static MLErrorCode	getTile (PagedImage image, SubImageBox loc, MLDataType datatype, void data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature.

static MLErrorCode	getTile (PagedImage image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature and Module passed as reference.

static MLErrorCode	updateImageProperties (PagedImage *image)
	For documentation see Host::updateImageProperties() function with same signature.

static void	freeTile (void *data)
	For documentation see Host::freeTile().

static void	updateProgress (const char info1, const char info2)
	For documentation see Host::updateProgress().

static bool	shouldTerminate ()
	For documentation see Host::shouldTerminate().

static Field *	getPressedNotifyField ()
	For documentation see Host::getPressedNotifyField().

static void	adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
	Adapt page size.

static std::string	getVoxelValueAsString (PagedImage image, const ImageVector &position, MLErrorCode errorCode=nullptr, const std::string &errorResult="")
	Returns the voxel value at position `position` of the image `image`.

static size_t	getNumModules ()
	Returns number of instantiated modules.

static Module *	getModule (size_t index)
	Returns pointer to instantiated module `index`.

static MLint	findModuleIndex (Module &module)
	Returns index of Module `module`. If not found -1 is returned.

static void	destroyModule ()
	Destroys static allocated tables to avoid memory leaks.

Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }
	Enumerator deciding whether and which type of multithreading is supported by this module. More...

Detailed Description

template<class T>
class ml::ListContainerTemplate< T >

Template module class ListContainerTemplate for a specific list class.

Class template for container modules for a specific list class. Contains a list object storing the internal list and implements the method to access this object.

To implement an instance of ListContainerTemplate with a given list type T (where T must be a subclass of BaseListTemplate), the following steps are necessary:

Derive a subclass from the template instance class ListContainerTemplate<T>
Use the ML_MODULE_CLASS_HEADER and ML_CLASS_SOURCE macros to implement the runtime type system for this class. In the ML_CLASS_SOURCE macro, use ListContainerBase in the base class argument.
Add field members to reflect additional list item properties (other than item id and name, which are handled by the base class).
Set _lockNotification = 1 in the constructor of the derived class while initializing field members to suppress handleNotification().
Overload the item property fields methods: isPropertyField() resetPropertyFields() updatePropertyFields()
Overload the list item operation methods: modifyItem() initItem()
If the derived class should be notified on changes to the active list (e.g. for graphical viewer or editor modules), overload the touchList() method.

Definition at line 373 of file mlListContainer.h.

Constructor & Destructor Documentation

◆ ListContainerTemplate()

template<class T >

ml::ListContainerTemplate< T >::ListContainerTemplate	(	int	inputNum,
		int	outputNum )

Constructor The values inputNum and outputNum specify the number of input and output image fields, resp.

Constructor.

Definition at line 497 of file mlListContainer.h.

References ml::ListContainerBase::_fldInputList, ml::ListContainerBase::_fldOutputList, ml::ListContainerTemplate< T >::_listPtr, ml::ListContainerBase::_lockNotification, ml::FieldContainer::addBase(), ML_CHECK_RUNTIME_TYPE, mlrange_cast(), and ml::BaseField::setBaseValueAndAddAllowedType().

◆ ~ListContainerTemplate()

template<class T >

ml::ListContainerTemplate< T >::~ListContainerTemplate ( )

inlineoverride

Destructor.

Definition at line 383 of file mlListContainer.h.

Member Function Documentation

◆ copyItemToTemplate()

template<class T >

void ml::ListContainerTemplate< T >::copyItemToTemplate ( MLssize_t index )

overrideprotectedvirtual

Copy values from item at position index to the template fields.

Implements ml::ListContainerBase.

Reimplemented in ml::XMarkerListContainer.

Definition at line 666 of file mlListContainer.h.

References mlrange_cast().

◆ copyTemplateToCurrent()

template<class T >

void ml::ListContainerTemplate< T >::copyTemplateToCurrent ( )

overrideprotectedvirtual

Copy the values of the templates fields to _currentItem.

Implements ml::ListContainerBase.

Reimplemented in ml::XMarkerListContainer.

Definition at line 677 of file mlListContainer.h.

◆ deleteItems()

template<class T >

void ml::ListContainerTemplate< T >::deleteItems	(	MLssize_t	index,
		MLssize_t	num )

overrideprotectedvirtual

Remove num items, starting at item index.

Implements ml::ListContainerBase.

Definition at line 581 of file mlListContainer.h.

References mlrange_cast().

◆ getId()

template<class T >

MLssize_t ml::ListContainerTemplate< T >::getId ( MLssize_t index )

overrideprotectedvirtual

Return the item id of the item index.

Implements ml::ListContainerBase.

Definition at line 550 of file mlListContainer.h.

References mlrange_cast().

◆ getInternalList()

template<class T >

ListBase * ml::ListContainerTemplate< T >::getInternalList ( )

inlineoverrideprotectedvirtual

Return address of internal list object.

Implements ml::ListContainerBase.

Definition at line 410 of file mlListContainer.h.

◆ getList()

template<class T >

virtual T * ml::ListContainerTemplate< T >::getList ( )

inlinevirtual

Get pointer to the active list object Use this pointer for list access after testing that it is != 0.

If the pointer is 0, an external object of a wrong type is connected to the input base field, in which case the module should be completely deactivated.

Definition at line 390 of file mlListContainer.h.

◆ initItem()

template<class T >

void ml::ListContainerTemplate< T >::initItem ( MLssize_t index )

overrideprotectedvirtual

Initialize the list item at position index.

This method is called by insertItem() if the fromCurrentItem argument is false. Moreover it is called when fldInit is touched.

This method is called by insertItem() if the fromCurrentItem argument is false. Moreover it is called when _fldClearItem is touched.

Implements ml::ListContainerBase.

Reimplemented in ml::XMarkerListContainer.

Definition at line 688 of file mlListContainer.h.

References mlrange_cast().

◆ insertItem()

template<class T >

void ml::ListContainerTemplate< T >::insertItem	(	MLssize_t	index,
		bool	fromCurrentItem )

overrideprotectedvirtual

Insert an item at position index.

If fromCurrentItem is true, the new item is initialized from _currentItem.

Implements ml::ListContainerBase.

Definition at line 599 of file mlListContainer.h.

References mlrange_cast(), and ml::BaseItem::setId().

◆ modifyItem()

template<class T >

bool ml::ListContainerTemplate< T >::modifyItem	(	MLssize_t	index,
		Field *	field,
		bool	fromCurrentItem )

overrideprotectedvirtual

Modify item at position index.

If fromCurrentItem is true, the item is copied from _currentItem, otherwise the item property corresponding to the property field field is modified. Return true if item has been modified.

Implements ml::ListContainerBase.

Reimplemented in ml::XMarkerListContainer.

Definition at line 631 of file mlListContainer.h.

References mlrange_cast().

◆ setActiveList()

template<class T >

bool ml::ListContainerTemplate< T >::setActiveList ( Base * basePtr )

overrideprotectedvirtual

Set the active list pointer _listPtr to basePtr, provided that it is of the correct type.

Otherwise the _listPtr is set to zero. Returns true if object is of correct type.

Implements ml::ListContainerBase.

Definition at line 531 of file mlListContainer.h.

References ML_BASE_IS_A, mlrange_cast(), and T.

◆ updatePropertyFields()

template<class T >

void ml::ListContainerTemplate< T >::updatePropertyFields ( )

overrideprotectedvirtual

Update property fields from the current list item.

Implements ml::ListContainerBase.

Reimplemented in ml::XMarkerListContainer.

Definition at line 560 of file mlListContainer.h.

References mlrange_cast().

Member Data Documentation

◆ _currentItem

template<class T >

T::itemType ml::ListContainerTemplate< T >::_currentItem

List item object used by insertItem() and modifyItem().

A derived editor module should use this variable to store a new or modified item and then call doInsertItem() or doModifyItem() with fromCurrentItem = true.

Definition at line 396 of file mlListContainer.h.

◆ _listPtr

template<class T >

T* ml::ListContainerTemplate< T >::_listPtr

protected

Pointer to the active list object Use this pointer for list access after testing that it is != 0.

If the pointer is 0, an external object of a wrong type is connected to the input base field, in which case the module should be completely deactivated.

Definition at line 460 of file mlListContainer.h.

Referenced by ml::ListContainerTemplate< T >::ListContainerTemplate().

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

MeVisLab/Standard/Sources/ML/MLBase/mlListContainer.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ListContainerTemplate()

◆ ~ListContainerTemplate()

Member Function Documentation

◆ copyItemToTemplate()

◆ copyTemplateToCurrent()

◆ deleteItems()

◆ getId()

◆ getInternalList()

◆ getList()

◆ initItem()

◆ insertItem()

◆ modifyItem()

◆ setActiveList()

◆ updatePropertyFields()

Member Data Documentation

◆ _currentItem

◆ _listPtr