ObjectInfo¶
-
MLModule
¶ genre InfoManagement
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLObjMgr
definition MLObjectManager.def see also ObjectManager
,ObjectFieldConnection
,ObjectLoader
,ObjectManagerInspector
,ObjectConstrainedIterator
,ObjectDump
,ObjectLoaderDump
keywords manager
Purpose¶
The module ObjectInfo
provides complete access to the ObjectManager database on an elementary level.
For conceptual information see ObjectManager
.
Usage¶
Connect the module to the ObjectManager or other ObjectManager-client modules and access the database.
ObjectManager-clients may be cascaded as shown in the figure below (ObjectFieldConnection is connected to the ObjectManager via an ObjectInfo module).
Input Fields¶
Output Fields¶
Parameter Fields¶
Field Index¶
Visible Fields¶
Priority¶
-
name:
priority
, type:
Integer
, default:
10000
¶ Sets the order in which this module is notified about modifications to the ObjectManager database.
A lower number indicates a higher priority when compared to other ObjectManager-clients.
Debug Comment¶
-
name:
debugComment
, type:
String
¶ Sets a string that will precede all debug messages to better distinguish multiple instances.
Only useful in debugging mode.
Successful¶
-
name:
operationSuccessful
, type:
Bool
, persistent:
no
¶ Shows whether the last operation was successful.
Receive Mode¶
-
name:
eventReceiveMode
, type:
Enum
, default:
All
¶ Defines the mode that determines which events will be received.
Values:
Title | Name | Description |
---|---|---|
None | None | This module will not receive notifications about any events. |
Selected | Selected | The module will get events whose object and layer signature matches a combination of the given object and layer lists. More precisely, an event will pass if its Object Id is in the object list ( |
All | All | All events will be communicated to this module. |
Accepted Object Ids¶
-
name:
acceptedObjects
, type:
String
, default:
*
¶ Sets Multiple object ids that can be separated by comma or semicolon.
Regular expressions may be used whereby the special pattern ‘*’ is handled separately for speedup.
Accepted Layer Ids¶
-
name:
acceptedLayers
, type:
String
, default:
Global
¶ Sets multiple layer ids that can be separated by comma or semicolon.
Regular expressions may be used whereby the special pattern ‘*’ is handled separately for speedup.
Id (objectID)¶
-
name:
objectID
, type:
String
¶ Sets an object id (information cell address component).
If this address component is used in a write-access to the database and the addressed object does not yet exist, it is created automatically. If this field is empty in a write-access, a unique numerical Object Id that does not yet exist in the database will be created and displayed afterwards. If the address component is used in a read-access and the addressed object does not exist, the
Successful
field will be set to false.
Id (layerID)¶
-
name:
layerID
, type:
String
¶ Sets a layer id (information cell address component).
If this address component is used in a write-access to the database and the addressed layer does not yet exist, it is created automatically. If this field is empty in a write-access or if it is used in a read-access and the addressed layer does not exist, the
Successful
field will set to be false.
Id (infoID)¶
-
name:
infoID
, type:
String
¶ Sets an information item id (information cell address component).
If this address component is used in a write-access to the database and the addressed information item does not yet exist, it is created automatically. If this field is empty in a write-access or if it is used in a read-access and the addressed information item does not exist, the
Successful
field will be set to false.
Persistent (objectPersistent)¶
-
name:
objectPersistent
, type:
Bool
, default:
TRUE
¶ If checked, the object is saved.
Persistent (layerPersistent)¶
-
name:
layerPersistent
, type:
Bool
, default:
TRUE
¶ If checked, the layer is saved.
Persistent (infoPersistent)¶
-
name:
infoPersistent
, type:
Bool
, default:
TRUE
¶ If checked, the info is saved.
Private (objectPrivate)¶
-
name:
objectPrivate
, type:
Bool
, default:
FALSE
¶ If checked, no event are emitted from this object.
Private (layerPrivate)¶
-
name:
layerPrivate
, type:
Bool
, default:
FALSE
¶ If checked, no event are emitted from this layer.
Private (infoPrivate)¶
-
name:
infoPrivate
, type:
Bool
, default:
FALSE
¶ If checked, no event are emitted from this info.
Net Comm Mode (objectNetCommMode)¶
-
name:
objectNetCommMode
, type:
Enum
, default:
Default
¶ Defines the network communication mode of this object.
Values:
Title | Name |
---|---|
Default | Default |
Communicate | Communicate |
Conceal | Conceal |
Net Comm Mode (layerNetCommMode)¶
-
name:
layerNetCommMode
, type:
Enum
, default:
Default
¶ Defines the network communication mode of this layer.
Values:
Title | Name |
---|---|
Default | Default |
Communicate | Communicate |
Conceal | Conceal |
Net Comm Mode (infoNetCommMode)¶
-
name:
infoNetCommMode
, type:
Enum
, default:
Default
¶ Defines the network communication mode of this info.
Values:
Title | Name |
---|---|
Default | Default |
Communicate | Communicate |
Conceal | Conceal |
Value (stringValue)¶
-
name:
stringValue
, type:
String
, deprecated name:
infoValue
¶ Sets and shows the item’s value.
Value (vec4Value)¶
-
name:
vec4Value
, type:
Vector4
, default:
0 0 0 0
¶ Sets and shows the item’s value.
Value (mat4Value)¶
-
name:
mat4Value
, type:
Matrix
, default:
1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1
¶ Sets and shows the item’s value.
Prefix (genObjIDPrefix)¶
-
name:
genObjIDPrefix
, type:
String
¶ Sets a string that precedes the generated numerical Object Id.
Gen Unique Id (genUniqueObjID)¶
-
name:
genUniqueObjID
, type:
Trigger
¶ If pressed, a unique object ID is generated. No object is actually created.
Prefix (genLayerIDPrefix)¶
-
name:
genLayerIDPrefix
, type:
String
¶ Sets a prefix generated number with given string.
Gen Unique Id (genUniqueLayerID)¶
-
name:
genUniqueLayerID
, type:
Trigger
¶ If pressed, a unique layer ID i sgenerated. No layer is actually created.
Creation Type¶
-
name:
infoType
, type:
Enum
, default:
omAttribute_std_string
¶ Defines the type of a newly the created cell.
Note that a String can handle all types.
Values:
Title | Name | Description |
---|---|---|
Base Ptr | omAttribute_BasePtr | |
MLint32 | omAttribute_MLint32 | |
bool | omAttribute_bool | |
double | omAttribute_double | |
mat4 | omAttribute_mat4 | |
om Message | omAttribute_omMessage | Message type. This type is like the ‘std string’ type but will emit a new event each time it is applied regardless of the info items previous value. This type is also not filtered by the ObjectManager event filter. |
std MLint32Vec | omAttribute_std_MLint32Vec | |
std string | omAttribute_std_string | |
std vec3Vec | omAttribute_std_vec3Vec | |
vec3 | omAttribute_vec3 | |
vec4 | omAttribute_vec4 |
Get Type¶
-
name:
getInfoType
, type:
Trigger
¶ If pressed, the storage type (data type) of the information item with the given address (Object Id, Layer Id, Info Id) is retrieved.
If the addressed information item does not exist, the
Successful
field will be set to false.
Search Pattern (searchObjPattern)¶
-
name:
searchObjPattern
, type:
String
, default:
*
¶ Next object must match this pattern