ml::ComposeBaseList Class Reference

Engine module ComposeBaseList composing two base objects. More...

#include <mlComposeBaseList.h>

Inheritance diagram for ml::ComposeBaseList:

List of all members.

Public Member Functions
	ComposeBaseList ()
	Constructor.
	~ComposeBaseList ()
	Destructor.
void	composeBaseList ()
	Compose the input objects to an output BaseList object:
Protected Member Functions
virtual void	activateAttachments ()
	calls handleNotification once after the module is loaded on the network and all field values are assigned.
virtual void	handleNotification (Field *field)
	handle field changes
Protected Attributes
BoolField *	_cascadeModeFld
	Compose mode.
BaseField *	_inputBase0Fld
	Base input 0:
BaseField *	_inputBase1Fld
	Base input 1:
BaseField *	_outputBaseListFld
	Base output:
IntField *	_outputSizeFld
	size (noElements) of the output list.
IntField *	_leftObjectIdFld
	Id of list item generated from left input object. If 0, no ID is assigned.
StringField *	_leftObjectNameFld
	Name of object at left input.
BoolField *	_useLeftObjectTypeFld
	Create name of object at left input automatically:
IntField *	_rightObjectIdFld
	Id of list item generated from right input object. If 0, no ID is assigned.
StringField *	_rightObjectNameFld
	Name of object at right input.
BoolField *	_useRightObjectTypeFld
	Create name of object at right input automatically:
BaseList *	_outputList
	Composed list:

---

Detailed Description

Engine module ComposeBaseList composing two base objects.

Composes two base objects in a new list, copying only the pointers to the actual base objects. In 'merge' mode, any input base object that already is of type BaseList, will not be treated as a solitary object but as a list of objects. In 'cascade' mode, however, a BaseList object is treated as an ordinary base object.

For example, let input 0 be an XMarkerList, and input 1 a ListBase object containing a KeyFrameList and a PointList. In merge mode, the ListBase object at the output will have three items, the KeyFrameList, the PointList, and the XMarkerList. In cascade mode there will be only two, the ListBase object and the XMarkerList.

Definition at line 63 of file mlComposeBaseList.h.

---

Constructor & Destructor Documentation

ml::ComposeBaseList::ComposeBaseList

(

)

Constructor.

ml::ComposeBaseList::~ComposeBaseList

(

)

Destructor.

---

Member Function Documentation

virtual void ml::ComposeBaseList::activateAttachments

(

)

[protected, virtual]

calls handleNotification once after the module is loaded on the network and all field values are assigned.

Reimplemented from ml::FieldContainer.

void ml::ComposeBaseList::composeBaseList

(

)

Compose the input objects to an output BaseList object:

virtual void ml::ComposeBaseList::handleNotification

(

Field *

field

)

[protected, virtual]

handle field changes

Reimplemented from ml::Module.

---

Member Data Documentation

BoolField* ml::ComposeBaseList::_cascadeModeFld [protected]

Compose mode.

Definition at line 86 of file mlComposeBaseList.h.

BaseField* ml::ComposeBaseList::_inputBase0Fld [protected]

Base input 0:

Definition at line 89 of file mlComposeBaseList.h.

BaseField* ml::ComposeBaseList::_inputBase1Fld [protected]

Base input 1:

Definition at line 92 of file mlComposeBaseList.h.

IntField* ml::ComposeBaseList::_leftObjectIdFld [protected]

Id of list item generated from left input object. If 0, no ID is assigned.

Definition at line 101 of file mlComposeBaseList.h.

StringField* ml::ComposeBaseList::_leftObjectNameFld [protected]

Name of object at left input.

Definition at line 104 of file mlComposeBaseList.h.

BaseField* ml::ComposeBaseList::_outputBaseListFld [protected]

Base output:

Definition at line 95 of file mlComposeBaseList.h.

BaseList* ml::ComposeBaseList::_outputList [protected]

Composed list:

Definition at line 120 of file mlComposeBaseList.h.

IntField* ml::ComposeBaseList::_outputSizeFld [protected]

size (noElements) of the output list.

Definition at line 98 of file mlComposeBaseList.h.

IntField* ml::ComposeBaseList::_rightObjectIdFld [protected]

Id of list item generated from right input object. If 0, no ID is assigned.

Definition at line 110 of file mlComposeBaseList.h.

StringField* ml::ComposeBaseList::_rightObjectNameFld [protected]

Name of object at right input.

Definition at line 113 of file mlComposeBaseList.h.

BoolField* ml::ComposeBaseList::_useLeftObjectTypeFld [protected]

Create name of object at left input automatically:

Definition at line 107 of file mlComposeBaseList.h.

BoolField* ml::ComposeBaseList::_useRightObjectTypeFld [protected]

Create name of object at right input automatically:

Definition at line 116 of file mlComposeBaseList.h.

---

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

• MeVisLab/Standard/Sources/ML/MLBase/mlComposeBaseList.h