SysML Plugin 19.0 LTR Documentation

The compartment is an area on or next to the shape used to display component properties. As an example, please see the figure below.

The parts, values, and proxy ports compartments are shown on the Water Heating Element Block shape.


The Compartment Editor allows you to display compartments and their properties on the Block:

  • constraints
  • flow properties
  • parts
  • properties (formerly :UML properties)
  • references
  • values
  • full ports
  • proxy ports
  • parameters

The following table explains which elements are displayed on a selected shape to show the additional information.

SysML specific compartments

Displayed Elements
constraints

Constraints and Constraint Properties.

Constraint Properties: properties typed by Constraint Blocks, or subtypes of Constraint Blocks, always having the ‘composite’ aggregation kind.

flow propertiesFlow Properties: properties that apply the «FlowProperty» stereotype.
partsPart Properties: properties typed by Blocks or subtypes of Blocks.
properties

All other properties that cannot be classified into the previous compartments.

references

Shared Properties and Reference Properties: properties typed by Blocks or subtypes of Blocks (except Constraint Block) having ‘shared’ and ‘none’ aggregation kind, respectively. There is no distinction between Shared Property and Reference Property.

values

Value Properties: properties typed by Value Types or subtypes of Value Types, always having the ‘composite’ aggregation kind.

full ports

The port is stereotyped by FullPort.

proxy ports

The port stereotyped by ProxyPort.

parametersConstraint Parameters.

The following sections outline the main procedures for working with the compartment area:

Creating elements in compartments


Unable to render {include} The included page could not be found.

Displaying and suppressing compartments


Unable to render {include} The included page could not be found.

Customizing compartments


Unable to render {include} The included page could not be found.


For example, the following procedure shows how to customize the compartments of a part.


To customize a compartment of a Part Property


  1. Right-click a Part Property shape and from the shortcut menu, select the Edit Compartment button.
  2. In the Compartment Edit dialog, select a compartment tab which you want to customize.
  3. Double-click an element or use the arrow buttons to move an element from the Hidden to the Selected area to display the element.
  4. Click OK when done.
The air and is properties are displayed on the r part shape by using the Compartment Edit dialog. The image is from the TemperatureRegulationLoop.mdzip sample model. Find it in modeling tool <modeling tool installation directory>\samples\SysML.
  • No labels