findElementsWithProperty

Find all elements with property value

Since R2023a

Syntax

elements = findElementsWithProperty(containerObj,kind,propertyName,propertyValue,propertyOperand)

elements = findElementsWithProperty(___,Name,Value)

Description

elements = findElementsWithProperty(containerObj,kind,propertyName,propertyValue,propertyOperand) finds all elements elements of type kind, with the property name propertyName, value propertyValue, or operand propertyOperand.

elements = findElementsWithProperty(___,Name,Value) finds all elements with properties with additional options specified by one or more name-value arguments.

Examples

Find Elements Using Query Programmatic Interfaces

Use functions in the System Composer™ query package to filter elements in a model.

Import the package that contains all of the System Composer queries.

import systemcomposer.query.*

Load the model and the profile.

sysModel = systemcomposer.loadModel('mBasicModel');
basicProfile = systemcomposer.loadProfile('mProfile');

Find all components in the model.

allComps = findElementsOfType(sysModel,"Component")

Find all ports in the model.

allPorts = findElementsOfType(sysModel,"Port")

Find all stereotypes in the model.

allStereotypes = findElementsOfType(basicProfile,"Stereotype")

Find all interfaces in the model.

allInterfaces = findElementsOfType(sysModel,"Interface")

Find components in the model with a name containing "c1".

nameComponents = findElementsWithProperty(sysModel,"Component","Name","c1","contains")

Find all stereotypes in the profile with a name containing "BasePort".

basePortStereotype = findElementsWithProperty(basicProfile,"Stereotype","Name","BasePort","eq")

Find all components in the model using the stereotype "BasePort".

basePorts = findElementsWithStereotype(sysModel,"Port",basePortStereotype)

Find all elements using the first two found interfaces.

portsUsingInterfaces = findElementsWithInterface(sysModel,"Port",[allInterfaces(1) allInterfaces(2)])

Input Arguments

containerObj — Container object

model object | dictionary object | profile object

Container object, specified as one of these options:

• systemcomposer.arch.Model

• systemcomposer.interface.Dictionary

• systemcomposer.profile.Profile

kind — Element type

"Component" | "Port" | "Connector" | "Interface" | "InterfaceElement" | "Stereotype"

Element type, specified as one of these options:

• "Component"

• "Port"

• "Connector"

• "Interface"

• "InterfaceElement"

• "Stereotype"

Data Types: string

propertyName — Property name

string

Property name, specified as a string.

Data Types: string

propertyValue — Property value

numeric | string | logical | value object

Property value, specified as a numeric, string, logical, or systemcomposer.query.Value object.

Data Types: string | numeric | logical

propertyOperand — Property operand

"eq" | "contains" | "lt" | "gt" | "ge" | "le" | "ne"

Property operand, specified as one of these options:

• eq — Equals

• contains — Contains

• lt — Less than

• gt — Greater than

• ge — Greater than or equal to

• le — Less than or equal to

• ne — Not equal to

Data Types: string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: basePortStereotype = systemcomposer.query.findElementsWithProperty(basicProfile,"Stereotype","Name","BasePort","eq",NegateResult=true,IncludeReferences=false,UseEvaluatedValue=false)

NegateResult — Whether to negate query result

false or 0 (default) | true or 1

Whether to negate query result, specified as a logical.

Data Types: logical

IncludeReferences — Option to search through reference architectures

true or 1 (default) | false or 0

Option to search through reference architectures, specified as a logical.

Data Types: logical

UseEvaluatedValue — Whether to evaluate value

true or 1 (default) | false or 0

Whether to evaluate value, specified as a logical.

Data Types: logical

Output Arguments

elements — Elements found

array of component objects | array of port objects | array of connector objects | array of data interface objects | array of data element objects | array of stereotype objects

Elements found, returned as an array of these objects:

• systemcomposer.arch.Component

• systemcomposer.arch.ComponentPort

• systemcomposer.arch.ArchitecturePort

• systemcomposer.arch.Connector

• systemcomposer.interface.DataInterface

• systemcomposer.interface.DataElement

• systemcomposer.profile.Stereotype

More About

Definitions

Term	Definition	Application	More Information
architecture	A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally.	Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor.	Compose Architectures Visually Author Parameters in System Composer Using Parameter Editor
model	A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.	Perform operations on a model: Extract the root-level architecture contained in the model. Apply profiles. Link interface data dictionaries. Generate instances from model architecture. A System Composer model is stored as an SLX file.	Create Architecture Model with Interfaces and Requirement Links
component	A component is a nontrivial, nearly independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, a system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction.	Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with: Port interfaces using the Interface Editor Parameters using the Parameter Editor	Components
port	A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems.	There are different types of ports: Component ports are interaction points on the component to other components. Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.	Ports
connector	Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures.	A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact.	Connections

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

Version History

Introduced in R2023a