getPortElement

Find port element by name

Since R2026a

Syntax

portElement = getPortElement(name)

Description

portElement = getPortElement(name) finds a port element or child port element by partial name specified by name.

Examples

Get Port Element by Name

Create a model and get the root architecture.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
rootArch = get(model,"Architecture");

Add a component and add a port to the component.

newComponent = addComponent(rootArch,"newComponent");
newPort = addPort(newComponent.Architecture,"newPort","in");

Add a first data interface with a data element.

newInterface = addInterface(model.InterfaceDictionary,"newInterface");
newElement = addElement(newInterface,"newElement",DataType="double");

Add a second data interface with a second data element.

newInterface2 = addInterface(model.InterfaceDictionary,"newInterface2");
newElement2 = addElement(newInterface2,"newElement2",DataType="double");

Type the first data element with the second data interface.

newElement.setType(newInterface2)

Set the first interface on the port.

setInterface(newPort,newInterface)

Access the data element from a port element.

portElement = getPortElement(newPort,'newElement')

portElement = 

  PortElement with properties:

                   Name: 'newElement'
                 Parent: [1×1 systemcomposer.arch.ArchitecturePort]
            SubElements: [1×1 systemcomposer.arch.PortElement]
       InterfaceElement: [1×1 systemcomposer.interface.DataElement]
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: -1
    SimulinkModelHandle: 149.0002
                   UUID: '40b38418-76b2-4a96-9da7-d6c6f237cf56'
            ExternalUID: ''

Input Arguments

name — Partial name of port element

character vector | string

Partial name of port element, specified as a character vector or string.

If name is specified as "a.b", the getPortElement function looks for the port element "a" and then looks for the child port element "b" inside of "a".

Example: "a.b"

Data Types: char | string

Output Arguments

portElement — Port element

port element object

Port element, returned as a systemcomposer.arch.PortElement object.

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
Root	A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest.	The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary.	Compose Architectures Visually
Model	A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors.	Perform operations on a model including extracting root-level architecture, applying profiles, linking interface data dictionaries, or generating 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 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, another 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 using port interfaces and parameters. Port interfaces and parameters can be configured using the Interface Editor and the Parameter Editor.	Compose Architectures Visually
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.	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. The root architecture has a boundary defined by its ports.	Compose Architectures Visually
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.	Compose Architectures Visually

Term	Definition	Application	More Information
Physical subsystem	A physical subsystem is a Simulink® subsystem with Simscape™ connections.	A physical subsystem with Simscape connections uses a physical network approach suited for simulating systems with real physical components and represents a mathematical model.	Implement Component Behavior Using Simscape
Physical port	A physical port represents a Simscape physical modeling connector port called a Connection Port (Simscape).	Use physical ports to connect components in an architecture model or to enable physical systems in a Simulink subsystem.	Define Physical Ports on Component
Physical connector	A physical connector can represent a nondirectional conserving connection of a specific physical domain. Connectors can also represent physical signals.	Use physical connectors to connect physical components that represent features of a system to simulate mathematically.	Architecture Model with Simscape Behavior for a DC Motor
Physical interface	A physical interface defines the kind of information that flows through a physical port. The same interface can be assigned to multiple ports. A physical interface is a composite interface equivalent to a Simulink.ConnectionBus object that specifies a number of Simulink.ConnectionElement objects.	Use a physical interface to bundle physical elements to describe a physical model using at least one physical domain.	Specify Physical Interfaces on Ports
Physical element	A physical element describes the decomposition of a physical interface. A physical element is equivalent to a Simulink.ConnectionElement object.	Define the Type of a physical element as a physical domain to enable use of that domain in a physical model.	Describe Component Behavior Using Simscape

Version History

Introduced in R2026a