removeQuery

Remove architecture view query

Since R2021a

Syntax

removeQuery(view,keepContents)

Description

removeQuery(view,keepContents) removes the selection query and groupings on the view view with the option to keep contents (keepContents), which leaves the elements that were selected in the view. removeQuery allows for manually editing the view element by element. If keepContents is true, any property-based groupings are kept intact in the diagram but removed from GroupBy.

Examples

Remove Query from View and Keep Contents

Open the keyless entry system example and create a view. Specify the color as light blue, the query as all components, and group by the review status.

import systemcomposer.query.*

openProject("scKeylessEntrySystem");
model = systemcomposer.loadModel("KeylessEntryArchitecture");
view = model.createView("All Components Grouped by Review Status",...
   Color="lightblue",Select=AnyComponent,...
    GroupBy="AutoProfile.BaseComponent.ReviewStatus");

Open the Architecture Views Gallery to see the new view All Components Grouped by Review Status.

model.openViews

Remove the query and keep the contents. The view is now manually editable element by element, and the groupings are preserved.

view.removeQuery(true)

Input Arguments

view — Architecture view

view object

Architecture view, specified as a systemcomposer.view.View object.

keepContents — Whether to keep contents in view

1 (true) (default) | 0 (false)

Whether to keep contents in view, specified as 1 (true) to keep contents specified by the removed selection query and property-based groupings or 0 (false). to remove all contents from the view.

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