Main Content

increaseStereotypeOrder

Move stereotype one level up

Since R2024a

    Description

    increaseStereotypeOrder(model,name) increases the stereotype order of the stereotype name in the architecture model model. If the stereotype already has the topmost order, this syntax is ignored.

    Stereotypes in a model are collected from all profiles imported into the model. When you apply multiple stereotypes to a component, the component uses the style defined in the topmost stereotype in the order.

    example

    Examples

    collapse all

    This example shows how to change the stereotype order for stereotypes applied to components. 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");

    Color model architecture model with color component component.

    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.

    Color model architecture model with color component component with a blue header.

    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")

    Color model architecture model with color component component with a green header.

    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")

    Color model architecture model with color component component with a red header.

    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

    collapse all

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

    Stereotype name, specified as a character vector or string. The name of the stereotype must be unique within the profile.

    Example: "electricalComponent"

    Data Types: char | string

    More About

    collapse all

    Version History

    Introduced in R2024a