MeVisLab Toolbox Reference
mlComposeBaseList.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_COMPOSE_BASE_LIST_H
14 #define ML_COMPOSE_BASE_LIST_H
15 
16 
19 
20 // Defines the classes:
21 //
22 // - BaseContainerItem : BaseItem-derived container class for Base-derived objects.
23 // - BaseList : BaseListTemplate<BaseContainer*>-derived container class for
24 // BaseContainer objects.
25 // - DecomposeBaseList : Operator with two output fields, decomposing a ListBase
26 // input into a single base object and a so-called "rest list".
27 //
28 
29 // ML includes
30 #include "mlModuleIncludes.h"
31 #include "mlEngine.h"
32 
33 
34 
35 #include "mlBaseInit.h"
36 
37 ML_START_NAMESPACE
38 
39 
40 // fwd dec
41 class BaseList;
42 
43 // ------------------------------------------------------------------
45 // ------------------------------------------------------------------
46 
52 
60 {
61 public:
62 
65 
67  ~ComposeBaseList () override;
68 
71 
72 protected:
73 
76  void activateAttachments() override;
77 
79  void handleNotification(Field* field) override;
80 
83 
86 
89 
92 
95 
98 
101 
104 
107 
110 
113 
114 
117 
118 private:
119 
122 
124 
125 
128 
129 };
130 
131 
132 ML_END_NAMESPACE
133 
134 
135 #endif // __mlComposeBaseList_H
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
Field to encapsulate a boolean value.
Definition: mlFields.h:62
Engine module ComposeBaseList composing two base objects.
BoolField * _cascadeModeFld
Compose mode.
StringField * _leftObjectNameFld
Name of object at left input.
IntField * _rightObjectIdFld
Id of list item generated from right input object. If 0, no ID is assigned.
BaseField * _inputBase1Fld
Base input 1:
StringField * _rightObjectNameFld
Name of object at right input.
BaseField * _outputBaseListFld
Base output:
IntField * _leftObjectIdFld
Id of list item generated from left input object. If 0, no ID is assigned.
BaseField * _inputBase0Fld
Base input 0:
~ComposeBaseList() override
Destructor.
void activateAttachments() override
calls handleNotification once after the module is loaded on the network and all field values are assi...
IntField * _outputSizeFld
size (noElements) of the output list.
BaseList * _outputList
Composed list:
ComposeBaseList()
Constructor.
BoolField * _useLeftObjectTypeFld
Create name of object at left input automatically:
void composeBaseList()
Compose the input objects to an output BaseList object:
void handleNotification(Field *field) override
handle field changes
BoolField * _useRightObjectTypeFld
Create name of object at right input automatically:
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