Engine module ExtractObjectFromList extracting a single list item (identified by its index) from a given list. More...
#include <mlExtractObjectFromList.h>
Public Member Functions | |
| ExtractObjectFromList () | |
| Constructor. | |
| ~ExtractObjectFromList () | |
| Destructor. | |
| void | updateOutput () |
| Compose the input objects to an output BaseList object: | |
Public Attributes | |
| IntField * | posFld |
| Position in list filtered by id (when useId is checked) and name (when useName is checked). | |
| BaseField * | outputObjectFld |
| Base output 0: first item as base object. | |
| BaseField * | inputListFld |
| Base input: | |
| IntField * | inputSizeFld |
| extract container instead of object if input list type is derived from BaseList | |
| BoolField * | inputValidFld |
| input is a valid list object? | |
| BoolField * | objectValidFld |
| indicates that the object found is valid (contained base object != NULL) | |
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. | |
Detailed Description
Engine module ExtractObjectFromList extracting a single list item (identified by its index) from a given list.
Extracts a single list item (identified by its index) from a given list (which, in contrast to DecomposeBaseList, has to be derived only from BaseListTemplate, not necessarily BaseList). No list filtering is done.
outputBase will contain the extracted object.
Definition at line 47 of file mlExtractObjectFromList.h.
Constructor & Destructor Documentation
| ml::ExtractObjectFromList::ExtractObjectFromList | ( | ) |
Constructor.
| ml::ExtractObjectFromList::~ExtractObjectFromList | ( | ) |
Destructor.
Member Function Documentation
| virtual void ml::ExtractObjectFromList::activateAttachments | ( | ) | [protected, virtual] |
calls handleNotification once after the module is loaded on the network and all field values are assigned.
Reimplemented from ml::FieldContainer.
| virtual void ml::ExtractObjectFromList::handleNotification | ( | Field * | field | ) | [protected, virtual] |
handle field changes
Reimplemented from ml::Module.
| void ml::ExtractObjectFromList::updateOutput | ( | ) |
Compose the input objects to an output BaseList object:
Member Data Documentation
Base* ml::ExtractObjectFromList::_outputObject [protected] |
Extracted object.
Definition at line 101 of file mlExtractObjectFromList.h.
Base input:
Definition at line 66 of file mlExtractObjectFromList.h.
extract container instead of object if input list type is derived from BaseList
size (noElements) of the input list.
Definition at line 72 of file mlExtractObjectFromList.h.
input is a valid list object?
Definition at line 75 of file mlExtractObjectFromList.h.
indicates that the object found is valid (contained base object != NULL)
Definition at line 78 of file mlExtractObjectFromList.h.
Base output 0: first item as base object.
Definition at line 63 of file mlExtractObjectFromList.h.
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 60 of file mlExtractObjectFromList.h.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLBase/mlExtractObjectFromList.h
