Main Content

Extend Architectural Elements

Add custom properties to architectural elements using stereotypes

System Composer™ provides five built-in element types: components, ports, connectors, interfaces, and functions. Functions are only available in software architectures. Create stereotypes to extend element types with metadata. Package related stereotypes into profiles for use with multiple models using the Profile Editor. Share profiles between models to ensure consistency within a project.

Stereotypes provide a template to define custom concepts and terminologies. Assign custom stereotypes to a model element to define its relation to the system. Properties defined within the stereotype applied to a model element can be used for early analyses, such as budget allocation, latency tradeoffs, and other parametric design concerns. You can add engineering units to property values to establish context.

In this example below, the profile MyCustomProfile contains multiple stereotypes. The SoftwareComponent stereotype extends the Component elements. The BluetoothLink stereotype extends Connector elements. You can further extend the SoftwareComponent stereotype with the SensorComponent stereotype to include additional properties such as DeviceID and FailureProb.

UML diagram of a custom System Composer profile.

Functions

expand all

systemcomposer.profile.Profile.createProfileCreate profile
systemcomposer.loadProfileLoad profile by name
applyProfileApply profile to model
removeProfileRemove profile from model
renameProfileRename profile in model
systemcomposer.profile.editorOpen Profile Editor
systemcomposer.profile.Profile.findFind profile by name
systemcomposer.profile.Profile.loadLoad profile from file
saveSave profile as file
openOpen profile
closeClose profile
systemcomposer.profile.Profile.closeAllClose all open profiles
systemcomposer.profile.Stereotype.findFind stereotype by name
getDefaultStereotypeGet default stereotype for profile
setDefaultStereotypeSet default stereotype for profile
getDefaultElementStereotypeGet default stereotype for elements
setDefaultElementStereotypeSet default stereotype for elements
addStereotypeAdd stereotype to profile
removeStereotypeRemove stereotype from profile
getStereotypeFind stereotype in profile by name
applyStereotypeApply stereotype to architecture model element
batchApplyStereotypeApply stereotype to all elements in architecture
getStereotypesGet stereotypes applied on element of architecture model
removeStereotypeRemove stereotype from model element
hasStereotypeFind if element has stereotype applied
addPropertyDefine custom property for stereotype
removePropertyRemove property from stereotype
hasPropertyFind if element has property
setPropertySet property value corresponding to stereotype applied to element
getPropertyGet property value corresponding to stereotype applied to element
getPropertyValueGet value of architecture property
getEvaluatedPropertyValueGet evaluated value of property from element
getStereotypePropertiesGet stereotype property names on element

Tools

Profile EditorCreate and manage profiles with stereotypes and properties
Instantiate Architecture ModelCreate an instance of the architecture model that you can use for analysis
Analysis ViewerView and edit analysis instance model and analyze using analysis function

Topics