API reference

This is the lookup section for the syside Python package, the library behind Automator. To find a symbol by name, type it into the Search symbols box in the left sidebar, which looks through the API alone; the search box at the top of the page covers the whole site. The pages below cover what a signature on its own does not say: the structures the symbols work on, and how to get a model in and out.

How-to guides:

  • Textual notation shows how to import and export SysML models from and to textual syntax.

  • JSON shows how to import and export SysML models from and to JSON.

Explanation:

  • Model structure describes the internal model structures and shows how to access and edit SysML models in Syside.

  • Expression evaluation shows how to evaluate expressions and features on a read-only model, user-defined functions included. The few operators it does not support are listed there.

  • Low-level API describes some of the low level interfaces for better performance and more advanced features.

Reference:

  • Version history shows breaking and some other bigger changes made with recent versions.

Symbol reference:

  • syside package is the auto-generated reference for the syside package.