getSubGroup

Get subgroup in element group of view

Since R2021a

Syntax

subGroup = getSubGroup(elementGroup,subGroupName)

Description

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

Examples

Create and Get Subgroup in View

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: '311855a0-5c0f-4dc7-987f-b4f7b2ae837d'
     Elements: []
    SubGroups: [0x0 systemcomposer.view.ElementGroup]

Input Arguments

elementGroup — Element group

element group object

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

subGroupName — Name of subgroup

character vector | string

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

Example: "myGroup"

Data Types: char | string

Output Arguments

subGroup — Subgroup

element group object

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

More About

Definitions

Term	Definition	Application	More 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.	Create Custom Views Using Architecture Views Gallery Modeling System Architecture of Keyless Entry System
element group	An element group is a grouping of components in a view.	Use element groups to programmatically populate a view.	Create Architecture Views Interactively Create Architecture Views Programmatically
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.	System Composer™ has 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