Main Content

renameProfile

Rename profile in model

    Description

    example

    renameProfile(modelName,oldProfileName,newProfileName) renames a profile on a model from oldProfileName to newProfileName to make it consistent if the name of the profile was changed in the file explorer.

    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.

    Examples

    collapse all

    Create a model.

    model = systemcomposer.createModel("archModel",true);

    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 model and close the model. Close the Profile Editor.

    save(model)
    close(model)

    Save the profile.

    save(profile)

    Rename the profile in the file explorer to LatencyProfileNew.xml.

    Load the model. Run the renameProfile API to update the model to refer to the correct renamed profile in the current directory.

    model = systemcomposer.loadModel("archModel");
    model.renameProfile("LatencyProfile","LatencyProfileNew");

    Input Arguments

    collapse all

    Model, specified as a systemcomposer.arch.Model object or a character vector or string as the name of the model.

    Example: "myModel"

    Example: archModel

    Data Types: char | string

    Old profile name, specified as a character vector or string.

    Example: "MyProfile"

    Data Types: char | string

    New profile name, specified as a character vector or string.

    Example: "MyProfileNew"

    Data Types: char | string

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    architecture

    A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. You can represent specific architectures using alternate views.

    Different types of architectures describe different aspects of systems:

    • Functional architecture describes the flow of data in a system.

    • Logical architecture describes the intended operation of a system.

    • Physical architecture describes the platform or hardware in a system.

    You can define parameters on the architecture level using the Parameter Editor.

    model

    A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.

    Perform operations on a model:

    • Extract the root-level architecture contained in the model.

    • Apply profiles.

    • Link interface data dictionaries.

    • Generate instances from model architecture.

    A System Composer model is stored as an SLX file.

    Create Architecture Model with Interfaces and Requirement Links
    component

    A component is a nontrivial, nearly independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, a system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction.

    Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with:

    Components
    port

    A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems.

    There are different types of ports:

    • Component ports are interaction points on the component to other components.

    • Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.

    Ports
    connector

    Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures.

    A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact.

    Connections

    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 R2020b