getStereotypeNamesByOrder

Get stereotype names by stereotype order in model

Since R2024a

Syntax

stereotypeNames = getStereotypeNamesByOrder(model)

Description

stereotypeNames = getStereotypeNamesByOrder(model) gets the order of stereotypes by stereotype names in the architecture model model.

Stereotypes in a model are collected from all profiles imported into the model. When you apply multiple stereotypes to a component, stereotype-based styling, such as the component header color, is inherited from the color defined in the topmost stereotype in the order.

Examples

Change Stereotype Order Programmatically

This example shows how to change the stereotype order for stereotypes applied to components using programmatic interfaces. System Composer™ collects the stereotypes in a model from all the profiles you import into the model. When you apply multiple stereotypes to a component, stereotype-based styling, such as the component header color, is inherited from the topmost stereotype in the order. For more information on the user interface, see Change Stereotype Order Using Manage Profiles Tool.

Display Stereotype Order for Component on Model

Load the model ColorModel.slx into system memory.

model = systemcomposer.loadModel("ColorModel");

Import the profile colorsProfile.xml into the model ColorModel.

model.applyProfile("colorsProfile")

Apply the BLUE, GREEN, and RED stereotypes to the ColorComponent component.

component = model.lookup(path="ColorModel/ColorComponent");
component.applyStereotype("colorsProfile.BLUE")
component.applyStereotype("colorsProfile.GREEN")
component.applyStereotype("colorsProfile.RED")

Display the order of the stereotypes programmatically.

stereotypeNames = cell2table(model.getStereotypeNamesByOrder)

stereotypeNames=1×3 table
             Var1                      Var2                      Var3         
    ______________________    _______________________    _____________________

    {'colorsProfile.BLUE'}    {'colorsProfile.GREEN'}    {'colorsProfile.RED'}

The topmost stereotype color blue appears on the component ColorComponent.

Change Stereotype Order for Component on Model

Components inherit the styling of the topmost stereotype. To change the styling for a component, change the stereotype order. To change your stereotype order, use these functions.

To move the blue stereotype one level down, enter this into your MATLAB® Command Window.

model.decreaseStereotypeOrder("colorsProfile.BLUE")

Now, the topmost stereotype is green.

stereotypeNames2 = cell2table(model.getStereotypeNamesByOrder)

stereotypeNames2=1×3 table
             Var1                       Var2                     Var3         
    _______________________    ______________________    _____________________

    {'colorsProfile.GREEN'}    {'colorsProfile.BLUE'}    {'colorsProfile.RED'}

To move the red stereotype to the top, increase its stereotype order twice.

model.increaseStereotypeOrder("colorsProfile.RED")
model.increaseStereotypeOrder("colorsProfile.RED")

Now, the topmost stereotype is red.

stereotypeNames3 = cell2table(model.getStereotypeNamesByOrder)

stereotypeNames3=1×3 table
            Var1                      Var2                       Var3         
    _____________________    _______________________    ______________________

    {'colorsProfile.RED'}    {'colorsProfile.GREEN'}    {'colorsProfile.BLUE'}

Restore the original stereotype order by explicitly ordering them.

model.applyStereotypeOrder(["colorsProfile.BLUE","colorsProfile.GREEN","colorsProfile.RED"])

Input Arguments

model — Architecture model

model object

Architecture model, specified as a systemcomposer.arch.Model object.

Output Arguments

stereotypeNames — Stereotype names

array of strings

Stereotype names, returned as an array of strings each in the form "<profile>.<stereotype>".

Example: "ElectricalProfile.ElectricalComponent"

Data Types: string

More About

Definitions

Term	Definition	Application	More Information
architecture	A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally.	Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor.	Compose Architectures Visually Author Parameters in System Composer Using Parameter Editor
root	The root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports surrounding the system of interest.	The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary.	Compose Architectures Visually
model	A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors.	Perform operations on a model: Extract root-level architecture. Apply profiles. Attach 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 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, another 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: Port interfaces using the Interface Editor Parameters using the Parameter Editor	Compose Architectures Visually
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.	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. The root architecture has a boundary defined by its ports.	Compose Architectures Visually
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.	Compose Architectures Visually

Term	Definition	Application	More Information
stereotype	Stereotypes provide a mechanism to extend the core language elements and add domain-specific metadata.	Apply stereotypes to core element types. An element can have multiple stereotypes. Stereotypes allow you to style different elements. Stereotypes provide elements with a common set of properties, such as mass, cost, and power.	Define Stereotypes and Perform Analysis for Mobile Robot Extend Architectural Design Using Stereotypes Change Stereotypes Based on Stereotype Hierarchy in Portable Blender Architecture
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.	Set Properties Add Properties with Stereotypes Set Properties for Analysis
profile	A profile is a package of stereotypes.	You can use profiles to create a domain of specialized 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.	Extend System Composer Language Elements Using Profiles Change Stereotype Order Using Manage Profiles Tool

Version History

Introduced in R2024a