All properties

All available properties in alphabetical order. The symbols on the right show if a property is only available to certain types of model components.

Additional Code

Defines additional ptlang primitive source code in context with a finite state machine. Likewise for MLDesigner primitive models, it is possible to include additional header files or to define global variables and functions. These functions can be called in any action associated with states, transitions or default entrances. Global variables can be read and written in any action and used in expressions of transition guard conditions.


Defines arbitrary annotion for custom purposes, which are only shown in the Property Editor. They can be separately edited for each model instance.


Defines the author. For primitives, the author is used to generate the author item in the primitive source code. For other types of model components it is used in the online documentation.

Background Color

Defines the color of the canvas in the Model Editor.

Compile Options

You can use this property to define a string of additional compiler options such as additional include search paths.


Defines the copyright notice. For primitives, the copyright is used to generate the copyright item in the primitive source code. For other types of model components it is used in the online documentation. This property is a free text string.

Create STD File

Allows you to revert FSM models to the old format. The main purpose for this property is the further support of FSM code-generating tools which are based on the semantic of Ptolemy and previous versions of MLDesigner. If the value of this property is set to Yes, the STD file with the name of the source FSM model and the extension .std is generated each time the associated FSM model is saved. For more information see Backward Compatibility of the FSM domain.


Can be used to change the name of the current state data structure associated with every FSM model. In this context, the old current state data structure is removed from the parent library model of the FSM model and a new generated current state data structure based on the new specified name is added to the parent library.

Default Bounding visible

Defines the default visibility setting for new model instances regarding the visibility of its bounding.

Default Icon

Defines the default icon to use for model instances. Note that this does not update already existing instances of this model.


Defines a primitive to derive from. The primitive inherits all ports, parameters and shared model elements such as Events, Memories and Resources from the selected primitive. Used to generate the derivedfrom item in the primitive source code. 


The description is a summary of the functionality of the model and is used for generating tooltip text. The text is also used as a short description for the online documentation of the model component. For primitives, the description generates the desc entry in the primitive source code.


This property generates the online documentation of the model component. Clicking the button in this field opens a text editor. HTML constructors to define a structured hypertext documentation can be entered. For primitives, the documentation property is used to generate the htmldoc item in the primitive source code.


Defines the modeling domain, that determines the model of computation for your model component. The property value is selected using a drop-down menu which contains entries for all known domains. If you select an experimental, unsupported domain, a warning message is displayed. For primitives this property is used to generate the domain item in the primitive source code. This property cannot be changed in primitive models.

Execution Condition

General description on how inputs are dealt with. Shown in the Inputs section in the online documentation.


Defines the visibility of the model. If a model is hidden and not writable it cannot be opened within the Model Editor.


This property can be used to document changes of the model. This property is a free text string.

Import Libraries

This field is normally filled in automatically. This is necessary, if you want to use composite data types (data structures) for model elements like parameters, ports and shared model elements (see Import Libraries). You have to import the libraries before you can use the relevant data structure types.

Internal Events

A space separated list of the names of the internal events of the finite state machine. Each time the value of this property changes, every item on the list of internal events is checked to see if it is unique in the scope of the FSM Model and not equal to the name of any interface element.

Linked Objects

You can use this property to define objects (shared libraries, static libraries or object files) from external libraries. This enables usage of external functionality within your primitive or system.

Load Mode

Defines the load mode. You can select the load mode as dynamic or permanent.

If you select load mode dynamic, a shared library containing the primitive code is created on loading. This shared library is linked dynamically to the simulation process so the primitive can be reloaded after changes are made to it without re-entering simulation mode

In contrast, by selecting load mode permanent, the primitive is linked to the simulation process when entering simulation mode as is the case with built-in primitives (MLDesigner Libraries). Changes to permanently loaded Primitives or Probes only take effect after re-entering simulation mode.

It only makes sense to set the load mode to permanent if you are going to create new primitives derived from the permanently loaded primitive. In such cases the permanently loaded primitive is known as the base primitive.

Logical Name

Defines the logical name of the model component. The logical name is used to identify the model component in the Tree View and is a string.

Model Type

Defines the type of the model component. This could be of type Primitive, FSM, Module, System, or Library. It is not possible to change the value of these properties once the component or module has been created. This is a required property.

Show Bounding

Defines the visibility of the model's canvas in the Model Editor. When deactivated Background Color is ignored.


Defines the target or top-level manager for the execution of the model. This property is only available for systems and modules. The value is selected from a drop-down menu. The drop-down menu contains all possible targets applicable to the selected model component/domain.


Defines a version number string. For primitives, the version string is used to generate the version item and must follow the conventions for the version string. For all other types of model component the version string is free text.