Main Content

systemcomposer.profile.Profile.find

Find profile by name

    Description

    profile = systemcomposer.profile.Profile.find finds all open profiles.

    example

    profile = systemcomposer.profile.Profile.find(name) finds a profile by the specified name, name.

    Examples

    collapse all

    Create a profile for latency characteristics and save it.

    profile = systemcomposer.profile.Profile.createProfile("LatencyProfile");
    
    latencybase = profile.addStereotype("LatencyBase");
    latencybase.addProperty("latency",Type="double");
    latencybase.addProperty("dataRate",Type="double",DefaultValue="10");
    
    connLatency = profile.addStereotype("ConnectorLatency",...
    Parent="LatencyProfile.LatencyBase");
    connLatency.addProperty("secure",Type="boolean");
    connLatency.addProperty("linkDistance",Type="double");
    
    nodeLatency = profile.addStereotype("NodeLatency",...
    Parent="LatencyProfile.LatencyBase");
    nodeLatency.addProperty("resources",Type="double",DefaultValue="1");
    
    portLatency = profile.addStereotype("PortLatency",...
    Parent="LatencyProfile.LatencyBase");
    portLatency.addProperty("queueDepth",Type="double");
    portLatency.addProperty("dummy",Type="int32");
    
    profile.save

    Find the profile by name.

    profileFound =  systemcomposer.profile.Profile.find("LatencyProfile")
    profileFound = 
    
      Profile with properties:
    
                Name: 'LatencyProfile'
        FriendlyName: ''
         Description: ''
         Stereotypes: [1×5 systemcomposer.profile.Stereotype]

    Input Arguments

    collapse all

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

    Example: "LatencyProfile"

    Data Types: char | string

    Output Arguments

    collapse all

    Found profile or profiles, returned as a systemcomposer.profile.Profile object or an array of systemcomposer.profile.Profile objects.

    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