Connection to Plant Simulation > Extended parameters

This section describes more extended parameter and settings within the SimUI-Plant libraries.

SimJSONImport

•v_bCreateMissingObj_UpdateMode: allow in update mode of a Plant Simulation model to create new objects, new structure node is imported

•v_bAdjustObjPosition_UpdateMode: allow in update mode of a Plant Simulation model to adjust positions of existing objects with import data

•v_bAdjustLinks_UpdateMode: allow to adjust links in update mode

•v_bDeleteObjects_ImportNotListed: delete objects in root model if they are not listed within imported structure

•v_bAdjustEventController: adjust Eventcontroller with Frontend data

•v_bSetEventControllerToMaxSpeed: adjust (ensure) Eventcontroller is running with maximum speed in the backend (independent from v_bAdjustEventController)

•v_tiAddSimTimeToEndForStatistics: add time to simulation run, e.g. in order to complete a certain statistics interval safely (add a fracture of second to complete an hour or day)

•v_iObjectCreationXOffset: offset in pixel in x direction

•v_iObjectCreationYOffset: offset in pixel in y direction

•v_bErrorWhenEmptyNodeDataArrayImported: allow empty input structures

•v_bAllowAnyToStringDataTypeAtImport: allow (or throw an error) if a parameter is not of type string and should be applied to string

•v_bIgnoreAdditionalTableColumnForImport: ignore if additional table columns are given

•v_bSimVSMUseNewYearly: breaking change in SimUI Shiftcalendar-Use  static=false (static for now)

SimJSONExport

•v_bUseModelSpecificSimulationToControllerInterfaceVersion: use model specific api-version, not the api-version of the toolbox (should be used if Simulation Model are exported with Update-Network-Mode)

•v_sModelSpecificSimModelVersion: model specific interface API-Version when bUseModelSpecificSimulationToControllerInterfaceVersion = true; applied to the Plant-Model in the SimController within settings.json -> settings -> Apps -> Plant Simulation -> Models -> model-name + “_api” + variable-value

othe method mGetSimControllerModelSettingsDef is returning the json-settings value for the SimController file settings (would then be similar if defined via webinterface of SimController)

•v_bIncludeBackgroundIconIntoDynamicToolboxExtension: include background image as base64 for the export into SimUI project

•v_bKeepJSONFile_ExportJSONModel: exported models are json-files in a zip file, renamed to a *.simui-file; if the source json file should also be kept for debugging reasons, check to true

Plant2Controller

•Parameter:

ov_bSaveInitModel: Save model directly before init call of plant simulation

ov_bSaveRunModel: Save run model after finishing and saving results

ov_bDeleteJobModelOriginFile: delete the copied Plant Simulation file which was placed into the job folder to start the simulation job

ov_bDebug_PreSetParameter: debug before setting the received parameter (mind the /noMessageBox-Parameter in the SimController-Settings)

ov_bDebug_PostSetParameter: debug after setting the received parameter

ov_bDebug_PreSaveResults: debug before saving results at the end

ov_bDebug_PostSaveResults: debug after saving results at the end

•User-Methods:

omUserSetParameter: set parameter to model, prefilled (could also be: copy specific data to Simulation Model or certain folder beforehand to run simulation)

omUserSaveResults: save and encode results in SimJSONResult

omUserSendResultData: send encoded results in SimJSONResult

omUserInitModel: user method around the init event of the eventcontroller

omUserStartModel: user method around the start event of the eventcontroller

ModelStartCtrl

•v_bIgnoreSimTalkBreakPoints: ignore Breakpoints, even necessary when /NoMessageBox-parameter is applied

•v_bIgnoreSimTalkBreakPoints_WhenLicenseRuntime: same as above with differentiation of using the Plant Simulation license type “runtime”

•v_bUsePlantAnimation: active or deactive Plant Simulation animation (only one call for all MU and icon animation)

•v_bAutoOpenModelFrame: open the defined model root frame (2D)

•v_iModelFrameWidthPxl: open Frame with width in pixel (2D)

•v_iModelFrameHeightPxl: open Frame with height in pixel (2D)