Main Content

systemcomposer.profile.Profile.createProfile

Create profile

    Description

    profile = systemcomposer.profile.Profile.createProfile(profileName,dirPath) creates a new profile object systemcomposer.profile.Profile to add a set of stereotypes. The dirPath argument specifies the directory in which the profile is to be created.

    Note

    Before you move, copy, or rename a profile to a different directory, you must close the profile in the Profile Editor or by using the close function. If you rename a profile, follow the example for the renameProfile function.

    example

    profile = systemcomposer.profile.Profile.createProfile(profileName) creates a new profile with name profileName.

    Examples

    collapse all

    Create a model.

    model = systemcomposer.createModel("archModel");

    Create a profile with a stereotype and properties, open the Profile Editor, then apply the profile to the model.

    profile = systemcomposer.profile.Profile.createProfile("LatencyProfile");
    latencybase = profile.addStereotype("LatencyBase");
    latencybase.addProperty("latency",Type="double");
    latencybase.addProperty("dataRate",Type="double",DefaultValue="10");
    systemcomposer.profile.editor(profile)
    model.applyProfile("LatencyProfile");

    Save the profile in a file in the current directory as LatencyProfile.xml.

    path = profile.save;

    Input Arguments

    collapse all

    Name of new profile, specified as a character vector or string. This name must be a valid MATLAB® identifier.

    Example: "LatencyProfile"

    Data Types: char | string

    Directory path where the profile will be saved, specified as a character vector or string.

    Example: "C:\Temp\MATLAB"

    Data Types: char | string

    Output Arguments

    collapse all

    Profile created, returned as a systemcomposer.profile.Profile 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