Displaying and Editing Modelica Parameters

For all classes you can display parameters and other modifiers, but not edit them. In an active and editable class, you can edit the parameters and other modifiers of one component, or multiselected components of the same class, at the same time. You can also edit the parameters and other modifiers of the activated class itself using the parameter dialog.

Notes:
  • The dialog box for editing Modelica parameters and other modifiers displays different tabs depending on the selected component or class.
  • If a class is read-only, you cannot edit the parameters and other modifiers of the components of it.
  • The task below about editing parameters only describes some of all the options you can use when you edit Modelica parameters by the General tab of the Modelica parameters edition dialog box. For a full description of the dialog box, including the Attributes tab and all alternatives in the context menu of a parameter or start value box, see Modelica Parameters Edition Dialog Box.

This task shows you how to:

See Also
About Parameters and Variables

Display Modelica Parameters and Other Modifiers of Classes

For all classes you can display parameters and other modifiers, but not edit them. This is a useful way to see what parameters you can have access to if you later instantiate the class in a model.

  1. In any Package Browser, right-click a class and select Edit Modelica Parameters .

    Tip: You can also select the class in any Package Browser, and from the Behavior Authoring section of the action bar, click Edit Modelica Parameters .

    The dialog box of the parameters and other modifiers of the selected class appears.
  2. Refer to Edit Modelica Parameters and Start Values of Components (skip Step 1 and Step 2) and Edit a Modelica Parameter or Start Value Attributes using the Context Command Edit below for a description what you can see in the dialog box.

Edit Modelica Parameters and Start Values of Components

You can, in an active and editable class, edit the parameters and other modifiers of one component, or multiselected components of the same class, at the same time.

  1. From the Component Browser or from the diagram, select one component or several components of the same class.
  2. Right-click the selected components and select Edit Modelica Parameters .

    Tip: You can also give the command any of the following way:
    • From the Behavior Authoring section of the action bar, click Edit Modelica Parameters .
    • From the diagram, from the context toolbar of one selected component, you can also select Edit Modelica Parameters .

    For more about the displayed box and options in it, see Modelica Parameters Edition Dialog Box.
  3. To see more information about the parameter, right-click the parameter box and select View Parameter Settings.
  4. If available, click Edit after the box to get help on how to, for example, insert matrix values.

    Tip: You can also click the small triangle after the box to display the context menu to select Edit .

    For more information, see Command Dialog Boxes and Editors.

  5. To find and insert any variable or component name (except protected ones) from the current model, including variables and components in subcomponents:
    1. Click the small triangle after the parameter or start value box in the Parameters or Initialization area in the General tab, then select Insert component reference.

      Tip: You can right-click the box to select this command from the context menu (except for Boolean parameters).

    2. Browse for a variable or component and select it.
    The variable or component, including the path to it, is inserted in the box.
    Note: The current content of the box is not replaced.
  6. To use code completion to, for example, write expressions in a parameter of start value box, press Ctrl+Space.
  7. To work with long text in a text editor, click the small triangle after the parameter or start value box and select Edit Text.
  8. If allowed, you can change the display units.

    Changeable display units have white background.

    1. Pause over the display unit.
    2. Click the button and select the display unit.
    3. To reset the display unit, click the triangle before the display unit and select Reset Display Unit.
  9. If available, to define a parameter as final, each, or replaceable, click the small triangle after the parameter or start value box and select final, each, or replaceable.

    For more information, see Context Menu Commands for Parameter and Start Value Boxes

  10. To change the behavior of a start value in the Initialization area in the General tab of the dialog box, do the following:
    1. Click the corresponding checkbox.
      Three of the four following alternative behaviors are available:
      • True: start-value is used to initialize
      • False: start-value is only a guess-value
      • Inherited: (True: start-value is used to initialize)
      • Inherited: (False: start-value is only a guess value)

      The two first alternatives are always available, and one of the two last ones, depending on if the inherited value is true or false.

    2. Click an alternative.
      By being activated or cleared, the checkbox displays if the start value is used to initialize or if it is only used as a guess value. However, to see if this behavior is inherited or not, you must click the checkbox to see which alternative that is selected.
  11. Click OK to exit the dialog box and save the Modelica parameters.

Edit a Modelica Parameter or Start Value Attributes using the Context Command Edit

You can define an attribute (minimum, maximum, unit...) for a parameter, variable or subparameters using the context command Edit in the component Modelica parameters dialog.

Notes:
  • The dialog box looks different depending on the type of parameter.
  • If available, you can also use the Edit command after the box. This command is described in the subtask above.
  • A replaceable class used in a component can be replaced, but you cannot edit its parameters.

Before you begin: The Modelica parameter edition dialog box of the relevant component must be displayed.

In this example, you edit the attributes of a parameter of real type.

  1. In the Parameters or Initialization area in the General tab, click the small triangle after the box of the parameter to edit, and select Edit .

    You can also right-click to box to display the context menu (except for Boolean parameters).

    A dialog box for editing attributes of the parameter appears.
  2. Optional: Edit the name and comment of the parameter.
  3. Define the following attributes for the Modelica parameter:
    • quantity: to change the value of the parameter.
    • unit: to change the unit of the parameter used in calculations.
    • displayUnit: to change the unit of the parameter for display in (for example) plot windows.
    • min: to change the minimum value of the parameter.
    • max: to change the maximum value of the parameter.
    • start: to change the start value of the parameter.
    • fixed: to set the value of the modifier fixed for the parameter. The following values can be selected from a list:
      • true: the start value is used to initialize.
      • false: the start value is used only as a guess value.
        Note: The default value is true for parameters, false for variables.
    • nominal: to indicate the magnitude of the value.
    • stateSelect sets the preference state selection. In the list, select a preference.
      Note: If you don´t select a preference, the default value is used.
      • never - Do not use as state at all.
      • avoid - Use as state only if it cannot be avoided.
      • default - Use as state if appropriate.
      • prefer - Prefer as state over the default ones.
      • always - Use as state.
      If you want to clear a present selection, the list contains <Remove modifier>.

Edit Modelica Parameters and Start Values of the Activated Class Itself

You can also edit the parameters and other modifiers of the activated class itself using the Modelica parameter dialog.

  1. From any browser containing the activated class, or from the root node of the Component Browser, right-click the activated class and select Edit Modelica Parameters .

    Tip: You can also:
    1. Make sure nothing is selected.
    2. From the Behavior Authoring section of the action bar, click Edit Modelica Parameters

    The dialog box for editing the parameters and other modifiers of the active class itself appears.
  2. You can now edit the parameters and other modifiers as described in Edit Modelica Parameters and Start Values of Components (skip Step 1 and Step 2) and Edit a Modelica Parameter or Start Value Attributes using the Context Command Edit above.