Creating a Modelica Library or Dymola Behavior Library

You can create a Modelica library or a Dymola behavior library. Both contain components that can be reused in functional or logical behaviors or behavior libraries. The difference (except different commands to create them) is only that when creating a Modelica library, the PLM names are created automatically.

This task shows you how to:

See Also
About Behavior Libraries
Managing External Resources

Create a Modelica Library

You can create a Modelica library by a command in the action bar.

This way of creating a library uses a simplified dialog box. If you want to also be able to specify also PLM names yourself, use the next subtask to create the library.

  1. From the Behavior Authoring section of the action bar, click New Modelica Library .
    The Library Creation dialog box appears.
  2. In the dialog box, do the following:
    1. In the Library Name box, enter the name of the library, in this example enter BatteryLib.

      Notes:
      • This Library Name is the name that is searched when using the Search box of the top bar.
      • Only characters allowed for Modelica names can be entered. See the Modelica Language Specification for further details.
      • You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

    2. Optional: In the Library Version box, enter the version of the library.

      Important: This version is different from the PLM versioning.

      Note: You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

    3. Optional: In the Description box, enter a description of the library.

      Important: You can enter as many characters as you want, but the text is always truncated to 256 characters.

    4. Optional: Activate the setting Add an empty model if you want an empty model Unnamed to be created in the new library.

      By default, such a model is not created in the library. However, in this scenario, activate this option.

    5. Click OK.
      The new library is displayed from the Package Browser. The Component Browser displays the content of the new library, in this case the empty model.

You can now work with the library, for example, creating classes to instantiate components within. See create a new class.

Notes:
  • Compared to the full dialog in the next subtask, the PLM names for the library are automatically created. See the result of the next subtask if you need to know those names.
  • You can change the name of a library by the command Class Attributes. If you change the name, the PLM names for the library are automatically changed.
    • For more information about the command Class Attributes, see Editing Class Attributes.
    • For more information about changing PLM names, see the result of the next subtask.

Create a Dymola Behavior Library

You can create a Dymola Behavior Library by a content command.

This way of creating a library lets you specify PLM names yourself. If you don´t want to do that, use the previous subtask to create the library.

  1. From the top bar, select Add > Content.
    The New content dialog box appears.
  2. Expand Types > Behavior Library, then select Dymola Behavior Library.
    The Dymola Behavior Library dialog box appears.
  3. From the Dymola Behavior Library tab:
    1. In the Title box, enter a title for the representation that stores the Modelica content, in this example enter BatteryLib_Representation.
    2. Optional: In the Description box, enter a description for the behavior library representation.

      Note: You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

    After creation, the PLM Representation Reference is seen as the parent enclosing the Modelica library (the level above the Modelica library in the tree).

  4. From the Modelica Attributes tab:

    This tab corresponds to the subtask above, except for the description box.

    1. In the Library Name box, enter a library name for the Modelica library, in this example enter BatteryLib.

      Notes:
      • This Library Name is the name that is searched when using the Search box of the top bar.
      • Only characters allowed for Modelica names can be entered. See the Modelica Language Specification for further details.
      • You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

    2. Optional: In the Library Version box, enter the version of the library.

      Important: This version is different from the PLM versioning.

      Note: You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

  5. From the Dymola Behavior Library Reference tab:
    1. In the Title box, enter a title for the reference that contains the behavior library representation within the database, in this example enter BatteryLib_Reference.
    2. Optional: In the Description box, enter a description of the library reference.

      Note: You can only enter a limited number of characters. When this limit is reached, you cannot enter more characters.

    After creation, the PLM Reference is seen as the parent enclosing the PLM Representation Reference (the second level above the Modelica library in the tree).

    Important: The PLM Reference title is searchable from the database.

  6. Click OK.
    The following is the result:
    • From the Dymola Behavior Modeling app, the new behavior library is displayed from the Package Browser and the Component Browser.

    • The new components in the tree looks like:

You can now work with the library, for example, creating classes to instantiate components within. See create a new class.

Notes:
  • If the library is created using the first subtask above, some PLM names for the library are automatically created since they cannot be entered:
    PLM Entities Editable for Content Command Automatically Created for Action Bar Command, From the Following
    (Representation) Title from the Dymola Behavior Library tab Library Name
    (Reference) Title from Dymola Behavior Library Reference tab Library Name
    (Reference) Description from Dymola Behavior Library Reference tab Description
  • You can change the name of a library by the command Class Attributes. If you change the library name, the PLM names for the library (the PLM Reference and the PLM Representation Reference) are automatically changed. For more information about the command Class Attributes, see Editing Class Attributes.
    Note: If you change the PLM Reference name or the PLM Representation Reference name, the library name is not changed.
  • To improve the use of this library in the Proposed Classes Browser right-click it in any Package Browser (the main one or any light ones) and select Manage Shortcuts > Index Library for Propositions.