Main Content

modifyQuery

Modify architecture view query and property groupings

    Description

    modifyQuery(view,select) modifies the query select on the view view.

    example

    modifyQuery(view,select,groupBy) modifies the query select on the view view and the property based groupings groupBy. If an empty cell array {} is passed into groupBy, all the groupings are removed.

    Examples

    collapse all

    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.*;
    
    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 named 'All Components Grouped by Review Status'.

    model.openViews

    Create a new query for all hardware components. Use the new query to modify the existing query on the view. Remove the property based groupings by passing in an empty cell array. Observe the change in your view.

    constraint = HasStereotype(IsStereotypeDerivedFrom('AutoProfile.HardwareComponent'));
    view.modifyQuery(constraint,{})

    Input Arguments

    collapse all

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

    Query to use to populate view, specified as a systemcomposer.query.Constraint object. A constraint can contain a sub-constraint that can be joined with another constraint using AND or OR. A constraint can be negated using NOT.

    Example: HasStereotype(IsStereotypeDerivedFrom('AutoProfile.HardwareComponent'))

    Query Objects and Conditions for Constraints

    Query ObjectCondition
    PropertyA non-evaluated value for the given property or stereotype property.
    PropertyValueAn evaluated property value from a System Composer object or a stereotype property.
    HasPortA component has a port that satisfies the given sub-constraint.
    HasInterfaceA port has an interface that satisfies the given sub-constraint.
    HasInterfaceElementAn interface has an interface element that satisfies the given sub-constraint.
    HasStereotypeAn architecture element has a stereotype that satisfies the given sub-constraint.
    IsInRangeA property value is within the given range.
    AnyComponentAn element is a component and not a port or connector.
    IsStereotypeDerivedFrom A stereotype is derived from the given stereotype.

    Grouping criteria, specified as a cell array of character vectors in the form '<profile>.<stereotype>.<property>'. The order of the cell array dictates the order of the grouping.

    Example: {'AutoProfile.MechanicalComponent.mass','AutoProfile.MechanicalComponent.cost'}

    Data Types: char

    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. Create views by adding 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 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.

    Modeling System Architecture of Keyless Entry System
    element groupAn element group is a grouping of components in a view.Use element groups to programmatically populate a view.
    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 Model Using Queries
    component diagramA 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 diagramYou 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

    Introduced in R2021a