Compartments (property)

Model Parts, Diagrams, Dictionary Items, and Properties > Properties > Compartments (property)

For automation interface information about the Compartments property (Compartment association through the automation interface), see the automation interface topic for Symbol Style in the Related Topics.

This property specifies compartments for an item.

A compartment displays information an item on a diagram:

• For a public property, the compartment shows the name and value of the property.

• For a public role, the compartment shows the name of the role and the items that are linked through that role.

• For a Stereotype, the compartment shows the name (or Name Alias or Keyword) of the Stereotype and each of its Tag Definitions that are set up as Shown Tag Defs for the diagram. For each shown Tag Definition the compartment shows the tagged value.

• For a Tag Definition, the compartment shows the name of the Tag Definition and its tagged value (for reference Tag Definitions the linked items are shown). If no value is set for the Tag Definition, the compartment is not shown on the diagram. You can show a compartment for a Tag Definition without setting up that Tag Definition as a Shown Tag Definition for the diagram.

Compartments are shown only when there is information to show.

When a Stereotype is used for a symbol compartment, its Name, Name Alias or Keyword can be used as the compartment title:

• If the Name Alias and Keyword properties are blank, the Stereotype Name is used as the compartment title.

• If a Name Alias is specified and the Keyword property is blank, the Stereotype Name Alias is used as the compartment title.

• If a Keyword is specified, the Stereotype Keyword is used as the compartment title.

You can show compartments for the following items on diagrams. In addition, you can show compartments for stereotyped versions of these items, for example, a SysML Block can show compartments because it is a stereotyped Class:

• Actions on General Flow Diagrams.

• Classes, Data Types, Interfaces and Signals on Class Diagrams and Composite Structure Diagrams.

• Instances on Object Diagrams.

• Parts on Composite Structure Diagrams.

• Notes on any diagram type when any item is linked to that Note.

For example, if you define compartments for an Actor and then link that Actor to a Note symbol, that Note symbol will show the Actor's compartments.

By default, no compartments are defined for an item.

This Property is set through the Style Modification dialog, which you open through the Edit button on the following tabs or dialogs:

• Style tab of a Symbol Style item's Property Pages.

• Style tab of an item's Property Pages.

• Style entry of a symbol's View Options dialog.

On the Style Modification dialog, click the Compartments tab, and move the compartments you want to show for the item to the Selected Compartments list.

You can order the compartments and hide the name of the Stereotype or Tag Definition for which each compartment is created.

For reference compartments, you can optionally show the type of referenced items, show the full name of referenced items, show the signature of referenced items that have signatures, and show the Constraints applied to referenced items. Note that if you choose to show full names and signatures, the signature is shown for referenced items that have signatures.

You can apply style settings to a symbol through the symbol, through the symbol's item, through an applied Stereotype or through a Symbol Style item.

The following section provides information about the items and diagrams for which Compartments is a property. For more information about an item or diagram, click it.