Associating a Modelica Command with a Model

You can create and edit commands associated to the current model to run scripts or call functions.

This task shows you how to:

Create a Modelica Command from a Script
Create a Modelica Command from a Function
Create a Modelica Command from a Plot
Run and Edit an Existing Modelica Command

Before you begin: Activate a model.

The new Modelica command is associated to this model.

Create a Modelica Command from a Script

You can use a script file to create a command that is used only in the current model.

From the Behavior Tools section of the action bar, click Modelica Commands .
Tip: You can also access this command from any of:

The App Options panel

The Action Pad panel
The Modelica Commands dialog box appears.
Select Create in this dialog box.
The Modelica Command Edition dialog box appears.
In the Associated Modelica command area:
1. Select Run script.
2. Click Resources Management .
The Resources Management dialog box appears.
The current library is highlighted.

You can select a file from the Modelica library or import an external file:

Tip: You can also create a new folder to store your script.

For this, select a folder from the library (its name appears in the Insert in field). Then enter a name for the new folder in the corresponding field and click Add Folder.

Select a script from the Modelica Library:
1. Expand the folder that contains the script in the Modelica Library.
2. Select the .mos file you want to use as script.
3. Click OK.
Import an external script:
1. Click Browse next to the Import a File field, in the Resources Management dialog box.
  The Select files dialog box appears.
2. Select a script then click Open.
  Warning: The file must be in .mos format.
  
  The Select files dialog box is closed. In the Resources Management dialog box, the name of the selected file appears in the Import a file field.
3. Click OK to confirm and close the Resources Management dialog box.

The script's path appears in the Run script field of the Modelica Command Edition dialog box.

Type a Description of the command in the corresponding field.
Select the Action on the model before command execution:
- No action
  The command is executed directly on the model.
- Translation
  The model is first translated, then the command is executed.
- Simulation
  The model is first simulated, then the command is executed.
Click OK.
The Modelica Command Edition dialog box is closed and your Modelica command is created and appears in the Modelica Commands dialog box.
In the Modelica Commands dialog box, click Close.
The script is stored as a Modelica command for the model.

Create a Modelica Command from a Function

You can use a function to create a command that is used only in the current model.

To open the Modelica Command dialog box, see step 1 and 2 in Create a Modelica Command from a Script.
In the Associated Modelica Command area, select Call function.
The dialog box for entering a function call is displayed.
Select the mandatory input line for the function, then select a function from the Package Browser.
The selected function appears in the dialog box.

Tip: It is possible to enter the path by hand, by clicking the input line twice. The path must respect the exact case of the function.
Select Resources Management in the dialog box.
A dialog box for editing the values used in the function call is displayed. Enter your values and edit them if needed.
Tip: If matrices are involved, see Working with the Matrix Editor.
In this dialog box:
- Click Info to display a Help window and information about the function.
- Click Copy Call to copy the script with the values. This can be used in further scripting.
- Click OK to execute the function and close this dialog box.
- Click Execute to execute the function without closing this dialog box. This allows you to test several values before validating.
Note: The Modelica Scripting Window appears only to let you see the result of the function execution. Modifying values in the Modelica Scripting Window does not modify the associated Modelica command.
Click Close to exit the Modelica Scripting Window and/or the Call function dialog box.
The function's path with its associated arguments appears in the Call function field of the Command dialog box.
Type a Description of the command in the corresponding field.
Select the Action on the model before command execution, see step 6 in Create a Modelica Command from a Script.
Check the Prompt for inputs box in the Modelica command execution option area if you want the function to start by displaying a dialog box where the input values can be modified.
Click OK.
The Modelica Command Edition dialog box is closed and your Modelica command is created and appears in the Modelica Commands dialog box.
In the Modelica Commands dialog box, click Close.
The function call is stored as a Modelica command for the model.

Create a Modelica Command from a Plot

You can use a plot to create a Modelica Command.

In the Modelica Command Edition dialog box, select Plot window setup.

In the Description field, enter the description of your plot, and then click OK.

Tips:

To save the plot window setup as a standard Figure item in the Modelica annotation Documentation of the model, you can activate Use standard Modelica plot setup.
You can activate the option Simulate to ensure that the model is simulated and Automatically run after simulation to automatically create the plot window when you simulate the model.
You can save the plot window setup as a Modelica command from the plot itself by right-clicking it and select Tools > Export plot definition to current model. For an example, see Saving the Plot Window Setup as a Modelica Command in the Model.

A new command associated to that script is generated.

Note: The script is saved as a .mos resource and stored in the model's library, under the PlotScript folder.

To run the command, see Run and Edit an Existing Modelica Command.

Run and Edit an Existing Modelica Command

You can select an available command to run it. You can also edit it or delete it.

In the Modelica Commands dialog box, select a command in the list of Available commands.

To run it, click

for most commands.
for plow window commands stored in Figure format.

Tip: You can also run an existing Modelica command by using context commands from the Variable Browser. For more information, see Saving the Plot Window Setup as a Modelica Command in the Model.

To edit it:
1. Click Edit.
  The Modelica Command Edition dialog box appears.
2. Edit the elements you want to change then click OK.
To delete it, click Delete.
The command disappears from the list of available commands.

Click Close to exit the Modelica Commands dialog box.

Note: You can edit a script related to a command using the scripting editor. To do so, select a command, and then click Open Script. For more information, see Working with the Modelica Script Editor.