About the DymolaCommands Library and Use of Commands

The DymolaCommands library contains recommended commands (built-in functions) that can be used in scripting.

Important: The DymolaCommands library must be opened by searching for the library. See Open with Search.

The following is an overview of the available groups. For included functions, open the library. For details about a certain function, see

  • information given by typing, in the input command line of the Modelica Scripting window, see Help.
  • The documentation layer of the function.

Important:
  • Function names are case sensitive.
  • Arguments must in most cases be added, even for functions having no arguments, for example when using the function getLastError, the call must be getLastError(); to be valid.
  • File paths cannot be specified using \, you must use / or \\ instead, for example E:/MyExperiment/Plots/....

This page discusses:

See Also
About Scripting

Help

The Help section contains a command document("functionName").

You can type the command in the input line of the Modelica Scripting window to get information about the function functionName. An example is: document("importFMU"). This command gives a detailed description, that might include examples.

Tip: To get short information about a function, use the command help functionName (where functionName is the name of the function). An example is: help importFMU.

Simulator API

The Simulator API section contains functions for handling the simulator API directly, for example opening, checking and executing a model.

System

The Simulator API section contains functions closely related to simulation, for example saving settings and tracing execution of interactive functions.

Plot

The Plot section contains functions for plot handling, for example creating plots and adding signal operators.

Trajectories

The Trajectories section contains functions for trajectory handling, for example returning output points of a trajectory, and names in a trajectory file.

Animation

The Animation section contains functions for animation handling, for example loading and running an animation.

Matrix IO

The Matrix IO section contains functions for handling arrays, matrices, and vectors.

Documentation

The Documentation section contains functions for handling information for documentation outside 3DEXPERIENCE.

Others

The Others section contains functions for version handling.