Main Content

getDefaultStereotype

Get default stereotype for profile

    Description

    example

    stereotype = getDefaultStereotype(profile) gets the default stereotype for a profile.

    Examples

    collapse all

    Create a profile for latency characteristics.

    profile = systemcomposer.profile.Profile.createProfile("LatencyProfileA");
    
    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");

    Set the default stereotype, then get the default stereotype.

    profile.setDefaultStereotype("NodeLatency");
    default = getDefaultStereotype(profile)
    default = 
      Stereotype with properties:
    
                        Name: 'NodeLatency'
                 Description: ''
                      Parent: [0x0 systemcomposer.profile.Stereotype]
                   AppliesTo: 'Component'
                    Abstract: 0
                        Icon: ''
        ComponentHeaderColor: [210 210 210]
          ConnectorLineColor: [168 168 168]
          ConnectorLineStyle: 'Default'
          FullyQualifiedName: 'LatencyProfileA.NodeLatency'
                     Profile: [1x1 systemcomposer.profile.Profile]
             OwnedProperties: [1x1 systemcomposer.profile.Property]
                  Properties: [1x1 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.

    Output Arguments

    collapse all

    Default stereotype, returned as a systemcomposer.profile.Stereotype object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    stereotype

    A stereotype is 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, functions, requirements, and links. Functions only apply to software architectures. You must have a Requirements Toolbox™ license to apply stereotypes to requirements and links. 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

    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 that you can use to create a self-consistent domain of 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