Main Content

addStereotype

Add stereotype to profile

Description

stereotype= addStereotype(profile,name)adds a new stereotype with a specified namenameto a profileprofile.

example

stereotype= addStereotype(___,Name,Value)adds a new stereotype with the previous input arguments and specifies properties for the stereotype.

Examples

collapse all

Add a component stereotype to a profile.

profile = systemcomposer.profile.Profile.createProfile('LatencyProfile'); stereotype = addStereotype(profile,'electricalComponent','AppliesTo','Component')
stereotype = Stereotype with properties: Name: 'electricalComponent' Description: '' Parent: [0x0 systemcomposer.profile.Stereotype] AppliesTo: 'Component' Abstract: 0 Icon: 'default' ComponentHeaderColor: [210 210 210] ConnectorLineColor: [168 168 168] ConnectorLineStyle: 'Default' FullyQualifiedName: 'LatencyProfile.electricalComponent' Profile: [1x1 systemcomposer.profile.Profile] OwnedProperties: [0x0 systemcomposer.profile.Property] Properties: [0x0 systemcomposer.profile.Property]

Input Arguments

collapse all

Profile, specified as asystemcomposer.profile.Profileobject.

Stereotype name, specified as a character vector or string. The name of the stereotype must be unique within the profile.

Data Types:char|string

Name-Value Arguments

Specify optional pairs of arguments asName1=Value1,...,NameN=ValueN, whereNameis the argument name andValueis the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and encloseNamein quotes.

Example:addStereotype(profile,'electricalComponent',AppliesTo="Component")

Description text for stereotype, specified as a character vector or string.

Example:addStereotype(profile,'electricalComponent',Description="These components are electrical")

Data Types:char|string

Icon name for stereotype, specified as a character vector or string. Built in options include:

  • "default"

  • "application"

  • "channel"

  • "controller"

  • "database"

  • "devicedriver"

  • "memory"

  • "network"

  • "plant"

  • "sensor"

  • "subsystem"

  • "transmitter"

This name-value argument is only valid for component stereotypes. The element a stereotype applies to is set with theAppliesToname-value argument.

Example:addStereotype(profile,"electricalComponent",Icon="default")

Data Types:char|string

从w刻板印象hich stereotype inherits properties, specified as asystemcomposer.profile.Stereotypeobject.

Example:addStereotype(profile,"electricalComponent",Parent=baseStereotype)

Element type to which stereotype can be applied, specified one of these options:

  • ""to apply stereotype to all element types

  • “组件”

  • "Port"

  • "Connector"

  • "Interface"

  • "Function", which is only available for software architectures

Example:addStereotype(profile,"electricalComponent",AppliesTo="Port")

Data Types:char|string

Whether stereotype is abstract, specified as a logical. Iftrue, then the stereotype cannot be directly applied on model elements, but instead serves as a parent for other stereotypes.

Example:addStereotype(profile,'electricalComponent','Abstract',true)

Data Types:logical

Component header color, specified as a 1x3uint32row vector in the form[Red Green Blue].

This name-value argument is only valid for component stereotypes. The element a stereotype applies to is set with theAppliesToname-value argument.

Example:addStereotype(profile,'electricalComponent','ComponentHeaderColor',[206 232 246])

Data Types:uint32

Connector line color, specified as a 1x3uint32row vector in the form[Red Green Blue].

这个名称参数只是有效连接or, port, and interface stereotypes. The element a stereotype applies to is set with theAppliesToname-value argument.

Example:addStereotype(profile,'electricalComponent','ConnectorLineColor',[206 232 246])

Data Types:uint32

Connector line style name, specified as a character vector or string. Options include:

  • "Default"

  • "Dot"

  • "Dash"

  • "Dash Dot"

  • "Dash Dot Dot"

这个名称参数只是有效连接or, port, and interface stereotypes. The element a stereotype applies to is set with theAppliesToname-value argument.

Data Types:char|string

Output Arguments

collapse all

Created stereotype, returned as asystemcomposer.profile.Stereotypeobject.

More About

collapse all

Definitions

Term Definition Application More Information
stereotype

Astereotypeis a custom extension of the modeling language. Stereotypes provide a mechanism to extend the architecture language elements by adding domain-specific metadata.

Apply stereotypes to model elements such as root-level architecture, component architecture, connectors, ports, data interfaces, value types, and functions. Functions only apply to software architectures. A model element can have multiple stereotypes. Stereotypes provide model elements with a common set of property fields, such as mass, cost, and power.

Extend Architectural Design Using Stereotypes
property

Apropertyis a field in a stereotype. You can specify property values for each element to which the stereotype is applied.

Use properties to store quantitative characteristics, such as weight or speed, that are associated with a model element. Properties can also be descriptive or represent a status. You can view and edit the properties of each element in the architecture model using the Property Inspector.

profile

Aprofileis a package of stereotypes to create a self-consistent domain of element types.

Author profiles and apply profiles to a model using theProfile Editor. You can store stereotypes for a project in one profile or in several. When you save profiles, they are stored in XML files.

Version History

Introduced in R2019a