Main Content

getStereotype

Find stereotype in profile by name

    Description

    example

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

    Examples

    collapse all

    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: 'default'
        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]
    
    

    Uncomment the following code and run to clean up the artifacts created by this example.

    % systemcomposer.profile.Profile.closeAll

    Input Arguments

    collapse all

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

    Name of stereotype to find, specified as a character vector or string.

    Data Types: char | string

    Output Arguments

    collapse all

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

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    stereotypeA 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 elements: root-level architecture, component architecture, connectors, ports, data interfaces, and value types of a model. 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
    propertyA property is a field in a stereotype. For each element the stereotype is applied to, specific property values are specified.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.
    profileA profile is a package of stereotypes 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 profile or in several. Profiles are stored in XML files when they are saved.

    Introduced in R2019a