Connection to Plant Simulation > Overview of libraries

To enable a Plant Simulation model to interact with the SimUI architecture, several libraries within the class library are provided for Plant Simulation.

Folder SimUIObjects

•Library SimUIToolbox

oToolboxCtrl (use within instance): Functions to create toolbox data (JSON based)

oToolboxDef_Class (use within instance): Toolbox definition for SimUI with Plant Simulation tables and variables

•Library SimJSON

oSimJSONCtrl (use within class library instance/public folder subclass): Various functions to interpret and encode model data in JSON / SimJSON format

▪SimJSONImport: Logics and Parameter for importing JSON data

▪SimJSONExport: Logics and Parameter to encode model JSON data

▪SimJSONResult: Logics and Parameter to encode result JSON data

•ToolboxCtrl: Controlling mechanisms for toolbox generation

oToolboxDef_Class: Define the contents of a Frontend Toolbox

•Library Plant2Controller

oPlant2Controller (use within instance): Communication interface with the SimController (Steps like experiment parameter, init, run, end of simulation run and, if necessary, error transmission)

oErrorCtrl (use within instance): Frame to administer error handling in the model, both register all Plant Simulation runtime errors, but also provides the possibility to register own checked errors within the simulation model

oModelStartCtrl (use within instance): Logics and parameter for starting the model (either duplicate a template or use a defined root model)

oAutoexec_template: Template for an autoexec method to automatically trigger a simulation run with interaction with the SimController

oEndsim_template: Template method for an endsim method within the root frame of the Plant Simulation model to register the end of a simulation run with the SimController

oEndm_error_demo: Template method for an endsim method with exemplary demonstrations on how the ErrorCtrl is either automatically invoked or how specific error messages can be sent (including automatically stopping and saving the simulation model)

oExtended parameters and methods here

•Folder SimUIObjects_Public:

oThis folder holds specific subclasses for adjustments and/or usage.

oThese subclasses were created to generate a user specific set of toolboxes, StartCtrl and especially a SimJSONCtrl with result definitions.

oThe subclasses are used so that class code in the library can be updated and that settings can be transferred to other models (settings in root model frame would be lost).

▪ToolboxDef

▪ToolboxCtrl

▪SimJSONCtrl

▪Plant2Controller

▪ErrorCtrl (if changes to class frame are necessary)

▪ModelStartCtrl

▪Autoexec (optional, could also be customer specific, start routines of ModelStartCtrl have to be triggered)

These subclasses were created to generate a user specific set of toolboxes, StartCtrl and especially a SimJSONCtrl with result definitions.

Subclasses are used so that class code in the library can be updated and that settings can be transferred to other models.

Example:

•Folder SimUIStatGathering_Example

oExemplary code outside of the SimUI-Libraries since this code is related to example gathering and therefore must be filled by the simulation expert

oCollect simulation results in data tables suitable for export

oSeveral exemplary interface method-calls to SimJSONResult, to:

▪Register a new result view section (if not already defined in SimJSON result)

▪Register a result data table

▪Register a result view widget within a result view section to visualize result data table entries within the front end