Main Content

addPort

Add ports to architecture

Description

example

ports = addPort(architecture,portNames,portTypes) adds a set of ports with specified names.

ports = addPort(architecture,portNames,portTypes,stereotypes) also applies stereotypes to a set of ports.

Examples

collapse all

Create a model, get the root architecture, add a component, and add a port.

model = systemcomposer.createModel('archModel',true);
rootArch = get(model,'Architecture');
newComponent = addComponent(rootArch,'NewComponent');
newPort = addPort(newComponent.Architecture,'NewCompPort','in')
newPort = 

  ArchitecturePort with properties:

                 Parent: [1×1 systemcomposer.arch.Architecture]
                   Name: 'NewCompPort'
              Direction: Input
          InterfaceName: ''
              Interface: [0×0 systemcomposer.interface.SignalInterface]
             Connectors: [0×0 systemcomposer.arch.Connector]
              Connected: 0
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: 52.0001
    SimulinkModelHandle: 49.0001
                   UUID: '98070dc5-1738-4dbf-b9b2-4fc781e7992c'
            ExternalUID: ''

Input Arguments

collapse all

Component architecture, specified as a systemcomposer.arch.Architecture object. addPort adds ports to the architecture of a component. Use <component>.Architecture to access the architecture of a component.

Names of ports, specified as a cell array of character vectors. If necessary, System Composer™ appends a number to the port name to ensure uniqueness. The size of portNames, portTypes, and stereotypes must be the same.

Data Types: char

Port directions, specified as a cell array of character vectors. A port direction can be either 'in' or 'out'.

Data Types: char

Stereotypes to apply to components, specified as an array of systemcomposer.profile.Stereotype objects. Each stereotype in the array must either be a stereotype that applies to all element types, or a port stereotype.

Output Arguments

collapse all

Created ports, returned as an array of systemcomposer.arch.ArchitecturePort objects.

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
architectureA System Composer architecture represents a system of components and how they interface with each other structurally and behaviorally. You can represent specific architectures using alternate views.

Different types of architectures describe different aspects of systems:

  • Functional architecture describes the flow of data in a system.

  • Logical architecture describes the intended operation of a system.

  • Physical architecture describes the platform or hardware in a system.

Compose Architecture Visually
modelA 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.

System Composer models are stored as .slx files.

Create an Architecture Model
componentA 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 architecture 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.Components
portA 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
connectorConnectors 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

TermDefinitionApplicationMore Information
stereotypeA stereotype is a custom extension of the modeling language. Stereotypes provide a mechanism to extend the architecture language elements by adding domain-specific metadata.Apply stereotypes to the root level architecture, component architecture, connectors, ports, and interfaces of a model. Stereotypes provide model elements within the architecture a common set of property fields, such as mass, cost, and power.Define Profiles and Stereotypes
profileA profile is a package of stereotypes to create a self-consistent domain of model element types.Apply profiles to a model through the Profile Editor. You can store stereotypes for a project in one profile or in several. Profiles are stored in .xml files when they are saved.Use Stereotypes and Profiles
propertyA property is a field in a stereotype. For each model element the stereotype is applied to, specific property values are specified.Use properties to store quantitative characteristics, such as weight or speed, that are associated with a model element. Properties can also be descriptive or represent a status.Set Properties

Introduced in R2019a