Event Properties

To view or edit an event's properties, double-click its Browser or list entry. The property sheet tabs and fields listed here are those available by default, before any customization of the interface by you or an administrator.

The General tab contains the following properties:
Property Description

Name/Code/Comment

Identify the object. The name should clearly convey the object's purpose to non-technical users, while the code, which is used for generating code or scripts, may be abbreviated, and should not normally include spaces. You can optionally add a comment to provide more detailed information about the object. By default the code is generated from the name by applying the naming conventions specified in the model options. To decouple name-code synchronization, click to release the = button to the right of the Code field.

Stereotype

Extends the semantics of the object beyond the core UML definition. You can enter a stereotype directly in this field, or add stereotypes to the list by specifying them in an extension file.

Keywords

Provide a way of loosely grouping objects through tagging. To enter multiple keywords, separate them with commas.

Dependencies Tab

The Dependencies tab contains a Triggered Objects tabbed tab that displays the actions on states and on transitions that are triggered by this event.

Parameters Tab

The Parameters tab lists all the parameters associated with the event. It allows you to define event parameters that correspond to the event signature. Add parameters to the list with the Add a Row tool, and view the properties of a parameter with the Properties tool.

A parameter has the following properties:

Property

Description

Parent

[Read-only] Event to which the parameter belongs

Name/Code/Comment

Identify the object. The name should clearly convey the object's purpose to non-technical users, while the code, which is used for generating code or scripts, may be abbreviated, and should not normally include spaces. You can optionally add a comment to provide more detailed information about the object. By default the code is generated from the name by applying the naming conventions specified in the model options. To decouple name-code synchronization, click to release the = button to the right of the Code field.

Data type

Set of instances sharing the same semantics

Array

When selected, indicates that the data type is a table format

Parameter Type

Direction of information flow for the parameter. Indicates what is returned when the parameter is called by the event during the execution process. You can choose from the following:
  • In – Input parameter passed by value. The final value can not be modified and information is not available to the caller

  • In/Out – Input parameter that may be modified. The final value may be modified to communicate information to the caller

  • Out – Output parameter. The final value may be modified to communicate information to the caller

Default value

Default value when a parameter is omitted. For example:

Use an operation oper(string param1, integer param2), and specify two arguments oper(val1, val2) during invocation. Some languages, like C++, allow you to define a default value that is then memorized when the parameter is omitted during invocation.

If the declaration of the method is oper(string param1, integer param2 = default), then the invocation oper(val1) is similar to oper(val1, default).