Connection to Plant Simulation > Toolbox definition

The toolbox of the exported project can be defined at an instance of the ToolboxDef_Class (Library SimUIToolbox).

Contents

1. General parameter

2. Item object definition

3. Item link definition

1. General parameter

•v_sToolboxID: string for identifying the toolbox

•v_sToolboxVersion: string for identifying the toolbox version

•v_sSimulationModelType:

ostring for API-interface at the SimController

oNot used when specific model name API is used (v_bUseModelSpecificSimulationToControllerInterfaceVersion and v_sModelSpecificSimModelVersion in SimJSONExport)

•v_sSimulationModelVersion:

ostring for API-interface at the SimController;

oNot used when specific model name API is used (v_bUseModelSpecificSimulationToControllerInterfaceVersion and v_sModelSpecificSimModelVersion in SimJSONExport)

•v_bUseIconFilesInFolder: use external icons (png or svg) for icon visualization; path is within v_sSrcIconFileFolderPath

•v_sSrcIconFileFolderPath: Windows path to the folder of the external icons for usage; icons must be defined in explicit sub-tables within the item object definition

2. Item object definition

Toolbox items (correspond to Plant Simulation classes) are defined in the table t_ItemObjDef with following columns:

•Class: unique identifier within SimUI-Toolbox, regularly Plant Simulation class name

•Active: object used/considered for export for toolbox and project files

•classPath: object path to the Plant Simulation class (necessary except for customText elements)

•category: distinguish between different element types within the front end:

oitem: regular simulation object with parameter

oicon: icon object for annotations

otext: specific text elements

•group: group id specified as group class in t_ItemGroupsDef

•hideInPalette: defines if a toolbox item is visible in the SimUI front end toolbox area; if not, copying (and inserting) in the modeling area are not possible/allowed

•title_localization_key: key-id for translation; translation for toolbox is within t_KeywordLocalization

•icons: sub-table only necessary when external icons are used (png or svg); within the sub-tables icons can be defined by:

oobjType: unique icon class

oiconname: file name without the file type within v_sSrcIconFileFolderPath

•parameters: definition of parameter for a toolbox item, with:

oclass: must be the attribute/variable name within the plant simulation class

otitle_localization_key: key-id for translation; translation for toolbox is within t_KeywordLocalization

otype: datatype of the attribute Note: for tables the type tableGrid should be used

ovalue: default value within the toolbox when creating new object in the modeling area; note: when exporting a SimUI project the corresponding/current values of the instance are taken

oparameterRelevantForSimulation: apply and read this parameter to or from the simulation model when importing/exporting

oshowCompact: there are three different parameter box visualization modes in the front end: all, compact and no parameter box; this value describes if the parameter should be shown at compact

orequired: enforces in the front end a parameter entry

oenumoptions: classes (unique values applied to Plant Simulation) and their localization key words

otable_header: header columns for table definitions (tableGrid, table); contents with analogous definition compared to attribute/parameter definition

otable_rows: optional default row definition

onumber_min: minimum value for a number attribute

onumber_max: maximum value for a number attribute

onumber_step: step value (increase/decrease button) for a number attribute

oJSONoptions: json element of form “{…}” to define specific options for this attribute

oJSONcustomData: json element of form “{…}” to define specific options for this attribute

Specific JSONoptions:

Possible adjustments for tableGrid attribute with specific behavior for editing:

•{"editing": {"enableRowDragging": true, "disableCreate": true, "disableUpdate": true, "disableDelete": true}}

•Also, only a subset of the editing functions can be used for tableGrid attributes

Specific JSONcustomData:

Text attribute with multiple lines (e.g. for notes):

•{"multiline": true}

As already indicated above, items can be aggregated to groups within the toolbox area of the front end.

For this, for every group id given in the t_ItemObjDef a corresponding group must be defined within t_ItemGroupsDef, incl. a link to the localization key word within the toolbox definition.

In general, groups for toolbox items are optional (also the column within t_ItemObjDef).

3. Item link definition

Possible link connections between item nodes can be defined within t_ConnectorObjDef with classes for connectors.

Allowed predecessor and successor connections between these connector classes can be defined within t_AllowedConnectorMatrix.

Connector definitions (incl. successor and predecessor matrix definitions) are optional.