getPort

Get port by name

Syntax

port = getPort(compObj,portName)

port = getPort(arch,portName)

Description

port = getPort(compObj,portName) gets the port on the component compObj with a specified name portName.

port = getPort(arch,portName) gets the port on the architecture arch with a specified name portName.

Examples

Connect Ports

Create and connect two ports in System Composer™.

Create a model and get the root architecture.

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

Create two new components.

names = ["Component1","Component2"];
newComponents = addComponent(rootArch,names);

Add ports to the components.

comp1 = getComponent(rootArch,"Component1");
comp2 = getComponent(rootArch,"Component2");
outPort1 = addPort(comp1.Architecture,"testSig","out"); 
inPort1 = addPort(comp2.Architecture,"testSig","in");

Extract the component ports.

srcPort = getPort(newComponents(1),"testSig");
destPort = getPort(newComponents(2),"testSig");

Connect the ports.

conns = connect(srcPort,destPort);

Improve the model layout.

Simulink.BlockDiagram.arrangeSystem("archModel")

Input Arguments

compObj — Component

component object

Component to get port from, specified as a systemcomposer.arch.Component or systemcomposer.arch.VariantComponent object.

arch — Architecture

architecture object

Architecture, specified as a systemcomposer.arch.Architecture object.

portName — Name of port

character vector | string

Name of port, specified as a character vector or string.

Example: "testSig"

Data Types: char | string

Output Arguments

port — Port

component port object | architecture port object

Port, returned as a systemcomposer.arch.ComponentPort or systemcomposer.arch.ArchitecturePort 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

Version History

Introduced in R2019a