getStereotype

Find stereotype in profile by name

Syntax

stereotype = getStereotype(profile,name)

Description

stereotype = getStereotype(profile,name) finds a stereotype in a profile by name.

Examples

Get Stereotype by Name

Create a profile for latency characteristics.

profile = systemcomposer.profile.Profile.createProfile("LatencyProfileB");

connLatency = profile.addStereotype("ConnectorLatency",AppliesTo="Connector");
connLatency.addProperty("secure",Type="boolean");
connLatency.addProperty("linkDistance",Type="double");

nodeLatency = profile.addStereotype("NodeLatency",AppliesTo="Component");
nodeLatency.addProperty("resources",Type="double",DefaultValue="1");

portLatency = profile.addStereotype("PortLatency",AppliesTo="Port");
portLatency.addProperty("queueDepth",Type="double");
portLatency.addProperty("dummy",Type="int32");

Get the stereotype ConnectorLatency in the profile.

stereotype = getStereotype(profile,"ConnectorLatency")

stereotype = 
  Stereotype with properties:

                    Name: 'ConnectorLatency'
             Description: ''
                  Parent: [0×0 systemcomposer.profile.Stereotype]
               AppliesTo: 'Connector'
                Abstract: 0
                    Icon: ''
    ComponentHeaderColor: [210 210 210]
      ConnectorLineColor: [168 168 168]
      ConnectorLineStyle: 'Default'
      FullyQualifiedName: 'LatencyProfileB.ConnectorLatency'
                 Profile: [1×1 systemcomposer.profile.Profile]
         OwnedProperties: [1×2 systemcomposer.profile.Property]
              Properties: [1×2 systemcomposer.profile.Property]

Close the profile to rerun this example.

profile.close(true)

Input Arguments

profile — Profile

profile object

Profile, specified as a systemcomposer.profile.Profile object.

name — Stereotype name

character vector | string

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

Example: "electricalComponent"

Data Types: char | string

Output Arguments

stereotype — Stereotype

stereotype object

Stereotype found, returned as a systemcomposer.profile.Stereotype object.

More About

Definitions

Term	Definition	Application	More Information
Stereotype	Stereotypes provide a mechanism to extend the core language elements and add domain-specific metadata.	Apply stereotypes to core element types. An element can have multiple stereotypes. Stereotypes allow you to style different elements. Stereotypes provide elements with a common set of properties, such as mass, cost, and power.	Define Stereotypes and Perform Analysis for Mobile Robot Extend Architectural Design Using Stereotypes Change Stereotypes Based on Stereotype Hierarchy in Portable Blender Architecture
Property	A property is 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. For more information, see Use Property Inspector in System Composer.	Set Properties Add Properties with Stereotypes Set Properties for Analysis
Profile	A profile is a package of stereotypes.	You can use profiles to create a domain of specialized element types. Author profiles and apply profiles to a model using the Profile Editor. You can store stereotypes for a project in one or several profiles. When you save profiles, they are stored in XML files.	Extend System Composer Language Elements Using Profiles Change Stereotype Order Using Manage Profiles Tool

Version History

Introduced in R2019a