Main Content

removeQuery

Remove architecture view query

    Description

    example

    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

    collapse all

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

    import systemcomposer.query.*;
    
    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 called '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

    collapse all

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

    Whether to keep contents in view, specified as a logical 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

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    viewA 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. Construct views by pulling in elements manually. Views create a simplified way to work with complex architectures by focusing on certain parts of the architecture design.

    You can use different types of views to represent the system:

    • Operational views demonstrate how a system will be used and should be well integrated with requirements analysis.

    • Functional views focus on what the system must do to operate.

    • Physical views show how the system is constructed and configured.

    A viewpoint represents a stakeholder perspective that specifies the contents of the view.

    element groupAn element group is a grouping of components in a view.Use element groups to programmatically populate a view.Create Architectural Views Programmatically
    queryA 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 a Model Using Queries

    Introduced in R2021a