MeVisLab Toolbox Reference
mlDecomposeBaseList.h
Go to the documentation of this file.
1 /*************************************************************************************
2 **
3 ** Copyright 2007, MeVis Medical Solutions AG
4 **
5 ** The user may use this file in accordance with the license agreement provided with
6 ** the Software or, alternatively, in accordance with the terms contained in a
7 ** written agreement between the user and MeVis Medical Solutions AG.
8 **
9 ** For further information use the contact form at https://www.mevislab.de/contact
10 **
11 **************************************************************************************/
12 
13 #ifndef ML_DECOMPOSE_BASE_LIST_H
14 #define ML_DECOMPOSE_BASE_LIST_H
15 
16 
20 
21 #include "mlBaseInit.h"
22 #include "mlEngine.h"
23 
24 
25 ML_START_NAMESPACE
26 
27 // fwd declaration
28 class BaseList;
29 
30 // ------------------------------------------------------------------
31 // Engine module DecomposeBaseList
32 // ------------------------------------------------------------------
33 
37 
41 {
42 public:
43 
46 
48  ~DecomposeBaseList () override;
49 
52 
55 
58 
61 
64 
67 
72 
75 
78 
81 
84 
87 
90 
93 
96 
99 
102 
103 protected:
104 
107  void activateAttachments() override;
108 
110  void handleNotification(Field* field) override;
111 
114 
117 
118 
119 private:
120 
123 
125 
126 
129 
130 };
131 
132 
133 ML_END_NAMESPACE
134 
135 
136 #endif // MLDECOMPOSEBASELIST_H
137 
Field to encapsulate a pointer to an ML base object.
Definition: mlFields.h:1187
Base object class BaseList which stores a list of BaseContainerItem entries.
Definition: mlBaseList.h:205
Class representing general ML objects that support import/export via strings (setPersistentState() an...
Definition: mlBase.h:62
Field to encapsulate a boolean value.
Definition: mlFields.h:62
Engine module decomposing a BaseList into one base object and a so-called rest list.
BoolField * useNameFld
Identify by name.
IntField * outPosFld
Position in Global List of the item that is outputted.
BoolField * objectValidFld
indicates that the object found is valid (contained base object != NULL)
DecomposeBaseList()
Constructor.
BoolField * useTypeFld
Identify by type.
~DecomposeBaseList() override
Destructor.
IntField * inputSizeFld
size (noElements) of the input list.
void handleNotification(Field *field) override
handle field changes
BoolField * objectFoundFld
indicates if an object matching the selected criteria has been found.
BaseField * inputBaseListFld
Base input:
BoolField * inputValidFld
input is a valid BaseList?
void decomposeBaseList()
Compose the input objects to an output BaseList object:
IntField * posFld
Position in list filtered by id (when useId is checked) and name (when useName is checked).
IntField * noItemsFoundFld
shows how many objects matched the filter criteria (id, name, type).
BaseList * _outputRestList
Composed rest list:
BaseField * outputObjectFld
Base output 0: first item as base object.
StringField * typeFld
Object type to be found.
StringField * nameFld
Object name to be found.
Base * _outputObject
Extracted object.
BoolField * useIdFld
Identify by id.
IntField * idFld
id to be found.
BaseField * outputRestListFld
Base output 1: rest of list.
void activateAttachments() override
calls handleNotification once after the module is loaded on the network and all field values are assi...
Base class for all ML Engines which are derived from Module, which have no inputs or outputs and whic...
Definition: mlEngine.h:30
Base class for all fields used in the ML.
Definition: mlField.h:73
Field to encapsulate an integer value.
Definition: mlFields.h:161
Field to encapsulate a string value.
Definition: mlFields.h:1000
#define ML_MODULE_CLASS_HEADER(className)
Like ML_CLASS_HEADER for the usage of derived classes from Module.
#define MLBASEEXPORT
defined Header file mlBaseInit.h
Definition: mlBaseInit.h:22