removeElement

Remove component from element group of view

Since R2021a

Syntax

removeElement(elementGroup,component)

Description

removeElement(elementGroup,component) adds the component component to the element group elementGroup of an architecture view.

Note

This function cannot be used when a selection query or grouping is defined on the view. To remove the query, run removeQuery.

Examples

Add Elements to View and Remove Elements from 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 newView.

model.openViews

Add an element to the view by path.

view.Root.addElement("KeylessEntryArchitecture/Lighting System/Headlights")

Add an element to the view by object.

component = model.lookup(Path="KeylessEntryArchitecture/Lighting System/Cabin Lights");
view.Root.addElement(component)

Remove an element to the view by path.

view.Root.removeElement("KeylessEntryArchitecture/Lighting System/Headlights")

Remove an element to the view by object.

view.Root.removeElement(component)

Input Arguments

elementGroup — Element group

element group object

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

component — Component

component object | variant component object | array of component objects | array of variant component objects | path to component | cell array of component paths

Component, specified as a systemcomposer.arch.Component object, a systemcomposer.arch.VariantComponent object, an array of systemcomposer.arch.Component objects, an array of systemcomposer.arch.VariantComponent objects, the path to a component, or a cell array of component paths.

Example: "KeylessEntryArchitecture/Lighting System/Headlights"

Data Types: char | string

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