getPort

Get port from component

Since R2019a

Syntax

port = getPort(compObj,portName)

Description

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

Examples

Connect Ports

Create and connect two ports in System Composer™.

Create a top-level architecture model.

modelName = "archModel";
arch = systemcomposer.createModel(modelName,true);
rootArch = get(arch,"Architecture");                  

Create two new components.

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

Add ports to the components.

outPort1 = addPort(newComponents(1).Architecture,"testSig","out"); 
inPort1 = addPort(newComponents(2).Architecture,"testSig","in");

Extract the component ports.

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

Connect the ports.

conns = connect(srcPort,destPort);

View the model.

systemcomposer.openModel(modelName);

Improve the model layout.

Simulink.BlockDiagram.arrangeSystem(modelName)

Input Arguments

compObj — Component

component object

Component to get port from, specified as a systemcomposer.arch.Component or systemcomposer.arch.VariantComponent 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 — Component port

component port

Component port, returned as a systemcomposer.arch.ComponentPort 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
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

Version History

Introduced in R2019a