Engine module decomposing a BaseList into one base object and a so-called rest list. More...

#include <mlDecomposeBaseList.h>

Inheritance diagram for ml::DecomposeBaseList:

Public Member Functions
	DecomposeBaseList ()
	Constructor.
	~DecomposeBaseList ()
	Destructor.
void	decomposeBaseList ()
	Compose the input objects to an output BaseList object:
Public Attributes
BoolField *	useIdFld
	Identify by id.
IntField *	idFld
	id to be found.
BoolField *	useNameFld
	Identify by name.
BoolField *	useTypeFld
	Identify by type.
StringField *	nameFld
	Object name to be found.
StringField *	typeFld
	Object type to be found.
IntField *	posFld
	Position in list filtered by id (when useId is checked) and name (when useName is checked).
IntField *	outPosFld
	Position in Global List of the item that is outputted.
BaseField *	outputObjectFld
	Base output 0: first item as base object.
BaseField *	outputRestListFld
	Base output 1: rest of list.
BaseField *	inputBaseListFld
	Base input:
IntField *	inputSizeFld
	size (noElements) of the input list.
BoolField *	inputValidFld
	input is a valid BaseList?
BoolField *	objectFoundFld
	indicates if an object matching the selected criteria has been found.
BoolField *	objectValidFld
	indicates that the object found is valid (contained base object != NULL)
IntField *	noItemsFoundFld
	shows how many objects matched the filter criteria (id, name, type).
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
Base *	_outputObject
	Extracted object.
BaseList *	_outputRestList
	Composed rest list:

Detailed Description

Engine module decomposing a BaseList into one base object and a so-called rest list.

The object can be identified by its name, its id and its position in the list.

output0 will contain the extracted object while output1 holds the rest list.

Definition at line 50 of file mlDecomposeBaseList.h.

Constructor & Destructor Documentation

ml::DecomposeBaseList::DecomposeBaseList ( )

Constructor.

ml::DecomposeBaseList::~DecomposeBaseList ( )

Destructor.

Member Function Documentation

virtual void ml::DecomposeBaseList::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::DecomposeBaseList::decomposeBaseList ( )

Compose the input objects to an output BaseList object:

virtual void ml::DecomposeBaseList::handleNotification ( Field * field ) [protected, virtual]

handle field changes

Reimplemented from ml::Module.

Member Data Documentation

Base* ml::DecomposeBaseList::_outputObject [protected]

Extracted object.

Definition at line 123 of file mlDecomposeBaseList.h.

BaseList* ml::DecomposeBaseList::_outputRestList [protected]

Composed rest list:

Definition at line 126 of file mlDecomposeBaseList.h.

IntField* ml::DecomposeBaseList::idFld

id to be found.

Definition at line 64 of file mlDecomposeBaseList.h.

BaseField* ml::DecomposeBaseList::inputBaseListFld

Base input:

Definition at line 93 of file mlDecomposeBaseList.h.

IntField* ml::DecomposeBaseList::inputSizeFld

size (noElements) of the input list.

Definition at line 96 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::inputValidFld

input is a valid BaseList?

Definition at line 99 of file mlDecomposeBaseList.h.

StringField* ml::DecomposeBaseList::nameFld

Object name to be found.

Definition at line 73 of file mlDecomposeBaseList.h.

IntField* ml::DecomposeBaseList::noItemsFoundFld

shows how many objects matched the filter criteria (id, name, type).

Definition at line 108 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::objectFoundFld

indicates if an object matching the selected criteria has been found.

Definition at line 102 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::objectValidFld

indicates that the object found is valid (contained base object != NULL)

Definition at line 105 of file mlDecomposeBaseList.h.

IntField* ml::DecomposeBaseList::outPosFld

Position in Global List of the item that is outputted.

Definition at line 84 of file mlDecomposeBaseList.h.

BaseField* ml::DecomposeBaseList::outputObjectFld

Base output 0: first item as base object.

Definition at line 87 of file mlDecomposeBaseList.h.

BaseField* ml::DecomposeBaseList::outputRestListFld

Base output 1: rest of list.

Definition at line 90 of file mlDecomposeBaseList.h.

IntField* ml::DecomposeBaseList::posFld

Position in list filtered by id (when useId is checked) and name (when useName is checked).

If neither one is checked, the overall list will be used. When the first occurence is requested, the value of choice is "1", whilst "-1" will be interpreted as a request to extract the last item.

Definition at line 81 of file mlDecomposeBaseList.h.

StringField* ml::DecomposeBaseList::typeFld

Object type to be found.

Definition at line 76 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::useIdFld

Identify by id.

Definition at line 61 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::useNameFld

Identify by name.

Definition at line 67 of file mlDecomposeBaseList.h.

BoolField* ml::DecomposeBaseList::useTypeFld

Identify by type.