Main Content

getSubGroup

Get subgroup in element group of view

Since R2021a

    Description

    example

    subGroup = getSubGroup(elementGroup,subGroupName) gets a subgroup, subGroup, named subGroupName within the element group elementGroup of an architecture view.

    Examples

    collapse all

    Open the keyless entry system example and create a view newView.

    openProject("scKeylessEntrySystem");
    model = systemcomposer.loadModel("KeylessEntryArchitecture");
    view = model.createView("newView");

    Open the Architecture Views Gallery to see the new view newView.

    model.openViews
    

    Create a subgroup myGroup.

    group = view.Root.createSubGroup("myGroup");

    Get the subgroup myGroup.

    getGroup = view.Root.getSubGroup("myGroup")
    getGroup = 
      ElementGroup with properties:
    
             Name: 'myGroup'
             UUID: '7666e089-6d79-4e14-8a7d-687a8b5e86a6'
         Elements: []
        SubGroups: [0x0 systemcomposer.view.ElementGroup]
    
    

    Input Arguments

    collapse all

    Element group for view, specified as a systemcomposer.view.ElementGroup object.

    Name of subgroup, specified as a character vector or string.

    Example: "myGroup"

    Data Types: char | string

    Output Arguments

    collapse all

    Subgroup, returned as a systemcomposer.view.ElementGroup object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    view

    A view shows a customizable subset of elements in a model. Views can be filtered based on stereotypes or names of components, ports, and interfaces, along with the name, type, or units of an interface element. Create views by adding elements manually. Views create a simplified way to work with complex architectures by focusing on certain parts of the architectural design.

    You can use different types of views to represent the system. Switch between a component diagram, component hierarchy, or architecture hierarchy. For software architectures, you can switch to a class diagram view. A viewpoint represents a stakeholder perspective that specifies the contents of the view.

    element group

    An element group is a grouping of components in a view.

    Use element groups to programmatically populate a view.

    query

    A query is a specification that describes certain constraints or criteria to be satisfied by model elements.

    Use queries to search elements with constraint criteria and to filter views.

    Find Elements in Model Using Queries
    component diagram

    A component diagram represents a view with components, ports, and connectors based on how the model is structured.

    Component diagrams allow you to programmatically or manually add and remove components from the view.

    Inspect Components in Custom Architecture Views
    hierarchy diagram

    You can visualize a hierarchy diagram as a view with components, ports, reference types, component stereotypes, and stereotype properties.

    There are two types of hierarchy diagrams:

    • Component hierarchy diagrams display components in tree form with parents above children. In a component hierarchy view, each referenced model is represented as many times as it is used.

    • Architecture hierarchy diagrams display unique component architecture types and their relationships using composition connections. In an architecture hierarchy view, each referenced model is represented only once.

    Display Component Hierarchy and Architecture Hierarchy Using Views

    Version History

    Introduced in R2021a