setPortQuery

Set port query on view

Since R2026a

Syntax

setPortQuery(view,select)

Description

setPortQuery(view,select) sets or removes a port query on a view.

Examples

Set Port Query on View

Set a port query on a new view in the keyless entry system architecture model.

Open the keyless entry system example and create a view. Specify the color as light blue and the query as all components.

import systemcomposer.query.*

openProject("scKeylessEntrySystem");
model = systemcomposer.loadModel("KeylessEntryArchitecture");
view = createView(model,"All Components",...
   Color="lightblue",Select=AnyComponent);

Set the port query to filter by ports named "keyLocation".

setPortQuery(view,Property("Name") == "keyLocation");

Open the Architecture Views Gallery to see the view All Components with the port query.

openViews(model)

Remove Port Query on View

Remove a port query on a new view in the keyless entry system architecture model.

Open the keyless entry system example and create a view. Specify the color as light blue and the query as all components.

import systemcomposer.query.*

openProject("scKeylessEntrySystem");
model = systemcomposer.loadModel("KeylessEntryArchitecture");
view = createView(model,"All Components",...
   Color="lightblue",Select=AnyComponent);

Set the port query to filter by ports named "keyLocation".

setPortQuery(view,Property("Name") == "keyLocation");

Open the Architecture Views Gallery to see the view All Components with the port query.

openViews(model)

Remove the port query.

setPortQuery(view,"");

Open the Architecture Views Gallery to see the view All Components without the port query.

openViews(model)

Input Arguments

view — Architecture view

view object

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

select — Query

constraint object

Query to use to populate view, specified as a systemcomposer.query.Constraint object.

A constraint can contain a subconstraint 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 Object	Condition
Property	A non-evaluated value for the given property or stereotype property.
PropertyValue	An evaluated property value from a System Composer™ object or a stereotype property.
HasConnector	A component has a connector that satisfies the given subconstraint.
HasPort	A component has a port that satisfies the given subconstraint.
HasInterface	A port has an interface that satisfies the given subconstraint.
HasInterfaceElement	An interface has an interface element that satisfies the given subconstraint.
HasStereotype	An architecture element has a stereotype that satisfies the given subconstraint.
IsInRange	A property value is within the given range.
AnyComponent	An element is a component and not a port or connector.
IsStereotypeDerivedFrom	A stereotype is derived from the given stereotype.

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.	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 R2026a