Main Content

getStereotype

Find stereotype in profile by name

Since R2019a

collapse all in page

    Syntax

    stereotype = getStereotype(profile,name)

    Description

    example

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

    Examples

    collapse all

    Open Live Script

    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: [0x0 systemcomposer.profile.Stereotype]
               AppliesTo: 'Connector'
                Abstract: 0
                    Icon: ''
    ComponentHeaderColor: [210 210 210]
      ConnectorLineColor: [168 168 168]
      ConnectorLineStyle: 'Default'
      FullyQualifiedName: 'LatencyProfileB.ConnectorLatency'
                 Profile: [1x1 systemcomposer.profile.Profile]
         OwnedProperties: [1x2 systemcomposer.profile.Property]
              Properties: [1x2 systemcomposer.profile.Property]

    Close the profile to rerun this example.

    profile.close(true)

    Input Arguments

    collapse all

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

    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

    collapse all

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

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore 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. Stereotype allow you to style different elements. Stereotypes provide elements with a common set of properties, such as mass, cost, and power.
    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.
    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.

    Version History

    Introduced in R2019a

    See Also

    | | |

    Topics