systemcomposer.arch.BasePort

R2026a

架构模型中的所有端口

描述

无法构造 BasePort 对象。创建 systemcomposer.arch.ArchitecturePort 或 systemcomposer.arch.ComponentPort 对象。systemcomposer.arch.BasePort 类源于 systemcomposer.arch.Element。

属性

全部展开

`Name` — 端口名称
字符向量

端口名称，指定为字符向量。

示例: 'newPort'

数据类型: char

`Direction` — 端口方向
`'Input'` | `'Output'` | `'Physical'` | `'Client'` | `'Server'`

端口方向，指定为字符向量。

数据类型: char

`Parent` — 端口所属架构
架构对象

端口所属架构，指定为 systemcomposer.arch.Architecture 对象。

`InterfaceName` — 与端口关联的接口名称
字符向量

与端口相关联的接口的名称，指定为字符向量。如果将 InterfaceName 指定为 ''，将 InheritsInterface 指定为 1，则该端口会跨连接继承接口。将 InterfaceName 指定为 '' 并定义了 Interface 对象时，该端口将具有专属接口。

数据类型: char

`Interface` — 与端口相关联的接口
数据接口对象 | 值类型对象 | 物理接口对象 | 服务接口对象

`InheritsInterface` — 端口是否继承接口
`1` (`true`) | `0` (`false`)

端口是否跨连接继承接口，指定为 1 (true) 或 0 (false)。

数据类型: logical

`Connectors` — 端口连接器
连接器对象数组

端口连接器，指定为 systemcomposer.arch.Connector 或 systemcomposer.arch.PhysicalConnector 对象数组。

`Connected` — 端口是否有连接
`1` (`true`) | `0` (`false`)

端口是否有连接，指定为 1 (true) 或 0 (false)。

数据类型: logical

`Model` — 父级 System Composer 模型
模型对象

父级 System Composer™ 模型，指定为 systemcomposer.arch.Model 对象。

`SimulinkHandle` — Simulink 句柄
双精度值

Simulink^® 句柄，指定为双精度类型。

此属性对于多个 Simulink 工作流以及使用 Requirements Toolbox™ 编程接口而言是必不可少的。

示例: handle = get(object,'SimulinkHandle')

数据类型: double

`SimulinkModelHandle` — 父模型的 Simulink 句柄
双精度值

Simulink 父级 System Composer 模型的句柄，指定为双精度数值。

此属性对于多个 Simulink 工作流以及使用 Requirements Toolbox 编程接口而言是必不可少的。

示例: handle = get(object,'SimulinkModelHandle')

数据类型: double

`ExternalUID` — 唯一外部标识符
字符向量

唯一外部标识符，指定为字符向量。外部 ID 在元素的整个生命周期以及所有保留 UUID 的操作中都会被保留。

数据类型: char

`UUID` — 统一唯一标识符
字符向量

统一唯一标识符，指定为字符向量

示例: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

数据类型: char

对象函数

`getConnectorTo`	Find connector between ports
`getProperty`	获取与应用于元素的构造型相对应的属性值
`setProperty`	设置与应用于元素的构造型相对应的属性值
`getPropertyValue`	获取架构属性值
`getEvaluatedPropertyValue`	从元素中获取属性的计算值
`getStereotypeProperties`	获取元素上的构造型属性名称
`applyStereotype`	将构造型应用于模型元素
`getStereotypes`	获取应用于模型元素的构造型
`changeStereotype`	将当前应用的构造型更改为其构造型层次结构中的新构造型
`removeStereotype`	从模型元素中移除构造型
`hasStereotype`	查找元素是否已应用构造型
`hasProperty`	查找元素是否具有属性
`current`	Get object of currently selected element
`destroy`	移除模型元素

示例

全部折叠

以编程方式构建架构模型

打开实时脚本

若要通过编程方式使用 System Composer™ 构建架构模型，请先添加一个包含数据接口、数据元素、值类型和物理接口的数据字典，然后添加组件、端口和连接。创建带有构造型和属性的配置文件，然后将这些构造型应用于模型元素。为端口分配专属接口。模型构建完成后，您可以创建自定义视图来关注特定的考虑因素。您还可以查询模型，根据指定的准则收集不同的模型元素。

添加组件、端口、连接和接口

创建一个模型并提取其架构。

model = systemcomposer.createModel("mobileRobotAPI");
arch = model.Architecture;

创建一个数据字典并添加一个数据接口。向该数据接口添加一个数据元素。向数据字典中添加一个值类型。将数据元素的类型指定为该值类型。添加一个物理接口和带有物理域类型的物理元素。将数据字典链接到模型。

dictionary = systemcomposer.createDictionary("SensorInterfaces.sldd");
interface = dictionary.addInterface("GPSInterface");
element = interface.addElement("SignalStrength");
valueType = dictionary.addValueType("SignalStrengthType",Units="dB", ...
    Description="GPS Signal Strength");
element.setType(valueType);
physicalInterface = dictionary.addPhysicalInterface("PhysicalInterface");
physicalElement = addElement(physicalInterface,"ElectricalElement", ...
    Type="electrical.electrical");
linkDictionary(model,"SensorInterfaces.sldd");

保存对数据字典的更改。

dictionary.save

保存模型。

model.save

打开模型。

systemcomposer.openModel("mobileRobotAPI");

在接口编辑器中查看接口。

Interface Editor with new data interfaces, data elements, value type, and physical interface

添加组件、端口和连接。将物理接口设置为稍后要连接的物理端口。

componentSensor = addComponent(arch,"Sensor");
sensorPorts = addPort(componentSensor.Architecture,{'MotionData','SensorPower'}, ...
    {'in','physical'});
sensorPorts(2).setInterface(physicalInterface)

componentPlanning = addComponent(arch,"Planning");
planningPorts = addPort(componentPlanning.Architecture, ...
    {'Command','SensorPower1','MotionCommand'}, ...
    {'in','physical','out'});
planningPorts(2).setInterface(physicalInterface)

componentMotion = addComponent(arch,"Motion");
motionPorts = addPort(componentMotion.Architecture,{'MotionCommand','MotionData'}, ...
    {'in','out'});

在 MotionData 端口上创建一个专属接口。在专属数据接口下添加一个专属数据元素。为数据元素 Rotation 指定一个单位设置为 degrees 的值类型。

ownedInterface = motionPorts(2).createInterface("DataInterface");
ownedElement = ownedInterface.addElement("Rotation");
subInterface = ownedElement.createOwnedType(Units="degrees");

在接口编辑器中查看接口。选择 Motion 组件上的 MotionData 端口。在接口编辑器中，将视图从字典视图切换为端口接口视图。

Port interface view in the Interface Editor with the MotionData port and its elements

使用接口规则和默认名称规则连接组件。接口规则会将共享同一接口的组件端口连接起来。默认情况下，名称规则会将共享相同名称的组件端口连接起来。

c_sensorData = connect(arch,componentSensor,componentPlanning,Rule="interface");
c_motionData = connect(arch,componentMotion,componentSensor);
c_motionCommand = connect(arch,componentPlanning,componentMotion);

添加和连接架构端口

在架构上添加一个架构端口。

archPort = addPort(arch,"Command","in");

connect 命令需要一个组件端口作为参量。获取组件端口，然后将其连接起来。

compPort = getPort(componentPlanning,"Command");
c_Command = connect(archPort,compPort);

保存模型。

model.save

按 Ctrl+Shift+A 键调整版面布局，或使用此命令。

Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI");

The mobileRobotAPI architecture model after running the script

创建和应用带有构造型的配置文件

配置文件是可以应用于任何模型的 XML 文件。您可以在配置文件中添加具有属性的构造型，然后在配置文件编辑器中用特定值来为这些属性赋值。除了 System Composer 的内置分析功能之外，构造型还可以帮助您优化系统的性能、成本和可靠性。

创建配置文件并添加构造型

创建一个配置文件。

profile = systemcomposer.createProfile("GeneralProfile");

创建一个适用于所有元素类型的构造型。

elemSType = addStereotype(profile,"projectElement");

为不同类型的组件创建构造型。您可以根据自己的设计需求选择适当的类型。

pCompSType = addStereotype(profile,"physicalComponent",AppliesTo="Component");
sCompSType = addStereotype(profile,"softwareComponent",AppliesTo="Component");

为连接创建一个构造型。

sConnSType = addStereotype(profile,"standardConn",AppliesTo="Connector");

添加属性

为构造型添加属性。您可以使用属性来捕获模型元素的元数据，并分析非功能性需求。在导入了该配置文件的任何模型中，这些属性都会被添加到应用了该构造型的所有元素中。

addProperty(elemSType,'ID',Type="uint8");
addProperty(elemSType,'Description',Type="string");
addProperty(pCompSType,'Cost',Type="double",Units="USD");
addProperty(pCompSType,'Weight',Type="double",Units="g");
addProperty(sCompSType,'develCost',Type="double",Units="USD");
addProperty(sCompSType,'develTime',Type="double",Units="hour");
addProperty(sConnSType,'unitCost',Type="double"',Units="USD");
addProperty(sConnSType,'unitWeight',Type="double",Units="g");
addProperty(sConnSType,'length',Type="double",Units="m");

保存配置文件

profile.save;

将配置文件应用到模型

将配置文件应用到模型。

applyProfile(model,"GeneralProfile");

将构造型应用于组件。有些组件是物理组件，有些组件是软件组件。

applyStereotype(componentPlanning,"GeneralProfile.softwareComponent")
applyStereotype(componentSensor,"GeneralProfile.physicalComponent")
applyStereotype(componentMotion,"GeneralProfile.physicalComponent")

将连接器构造型应用于所有连接。

batchApplyStereotype(arch,'Connector',"GeneralProfile.standardConn");

将通用元素构造型应用于所有连接器和端口。

batchApplyStereotype(arch,'Component',"GeneralProfile.projectElement");
batchApplyStereotype(arch,'Connector',"GeneralProfile.projectElement");

为每个组件设置属性。

setProperty(componentSensor,'GeneralProfile.projectElement.ID','001');
setProperty(componentSensor,'GeneralProfile.projectElement.Description', ...
    'Central unit for all sensors');
setProperty(componentSensor,'GeneralProfile.physicalComponent.Cost','200');
setProperty(componentSensor,'GeneralProfile.physicalComponent.Weight','450');
setProperty(componentPlanning,'GeneralProfile.projectElement.ID','002');
setProperty(componentPlanning,'GeneralProfile.projectElement.Description', ...
    'Planning computer');
setProperty(componentPlanning,'GeneralProfile.softwareComponent.develCost','20000');
setProperty(componentPlanning,'GeneralProfile.softwareComponent.develTime','300');
setProperty(componentMotion,'GeneralProfile.projectElement.ID','003');
setProperty(componentMotion,'GeneralProfile.projectElement.Description', ...
    'Motor and motor controller');
setProperty(componentMotion,'GeneralProfile.physicalComponent.Cost','4500');
setProperty(componentMotion,'GeneralProfile.physicalComponent.Weight','2500');

将所有连接的属性设置为相同值。

connections = [c_sensorData c_motionData c_motionCommand c_Command];
for k = 1:length(connections)
    setProperty(connections(k),'GeneralProfile.standardConn.unitCost','0.2');
    setProperty(connections(k),'GeneralProfile.standardConn.unitWeight','100');
    setProperty(connections(k),'GeneralProfile.standardConn.length','0.3');
end

添加层次结构

在 Motion 组件内添加两个名为 Controller 和 Scope 的组件。定义端口。将组件连接到架构以及彼此之间，并应用连接器构造型。架构图中的层次结构可以为组件的内部行为提供更详细的描述。

motionArch = componentMotion.Architecture;

motionController = motionArch.addComponent('Controller');
controllerPorts = addPort(motionController.Architecture,{'controlIn','controlOut'}, ...
    {'in','out'});
controllerCompPortIn = motionController.getPort('controlIn');
controllerCompPortOut = motionController.getPort('controlOut');

motionScope = motionArch.addComponent('Scope');
scopePorts = addPort(motionScope.Architecture,{'scopeIn','scopeOut'},{'in','out'});
scopeCompPortIn = motionScope.getPort('scopeIn');
scopeCompPortOut = motionScope.getPort('scopeOut');

c_planningController = connect(motionPorts(1),controllerCompPortIn);

对于输出端口连接，可以指定目标数据元素。

c_planningScope = connect(scopeCompPortOut,motionPorts(2),DestinationElement="Rotation");
c_planningConnect = connect(controllerCompPortOut,scopeCompPortIn, ...
    "GeneralProfile.standardConn");

保存模型。

model.save

按 Ctrl+Shift+A 键调整版面布局，或使用此命令。

Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI/Motion");

Inside the Motion component architecture model

创建模型引用

模型引用可以帮助您按层次结构组织大型模型，并可实现对其架构和行为的一次定义，多次重用。当一个组件引用另一个模型时，该组件上现有的所有端口将被移除，而被引用模型上的端口将显示在该组件上。

创建一个新的 System Composer 模型。将 Controller 组件转换为引用组件，以引用新模型。要在 Controller 组件上添加端口，必须更新引用模型 mobileMotion。

referenceModel = systemcomposer.createModel("mobileMotion");
referenceArch = referenceModel.Architecture;
newComponents = addComponent(referenceArch,"Gyroscope");
referenceModel.save

linkToModel(motionController,"mobileMotion");

Controller component linked to the referenced model mobileMotion

保存模型。

referenceModel.save
model.save

创建变体组件

您可以使用 makeVariant 函数将 Motion 组件转换为变体组件。原始组件会作为可选的变体选择项之一嵌入到变体组件中。您可以在变体组件中设计其他变体选择项，并切换活动选择项。变体组件允许您在架构模型中以编程方式选择不同的行为设计，从而进行权衡研究和分析。

[variantComp,choice1] = makeVariant(componentMotion);

添加一个名为 MotionAlt 的变体选择项。第二个参量定义名称，第三个参量定义标签。标签用于标识选择项。活动选择项由标签控制。

choice2 = addChoice(variantComp,{'MotionAlt'},{'MotionAlt'});

在 MotionAlt 上创建必要的端口。

motionAltPorts = addPort(choice2.Architecture,{'MotionCommand','MotionData'},{'in','out'});

将 MotionAlt 设为活动变体。

setActiveChoice(variantComp,"MotionAlt")

按 Ctrl+Shift+A 键调整版面布局，或使用此命令。

Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI/Motion");

The Motion variant component with two variants

保存模型。

model.save

清理

若要在再次运行此示例之前删除生成的工件，请运行此脚本。

cleanUpArtifacts

详细信息

全部展开

定义

术语	定义	应用	更多信息
架构	System Composer 架构代表由组件组成的系统，以及这些组件在结构上和行为上如何相互关联。	不同类型的架构描述系统的不同方面。您可以使用视图来可视化架构中的组件子集。您可以使用参数编辑器在架构层级上定义参数。	可视化构建架构在 System Composer 中使用参数编辑器编写参数
根	根位于架构层次结构的顶层。根架构的边界由围绕相关系统的架构端口定义。	根架构的系统边界包围着您的架构模型。您可以添加架构端口来定义跨边界接口。	可视化构建架构
模型	System Composer 模型是包含架构信息的文件，涵盖组件、端口、连接器、接口和行为等信息。	对模型执行操作，包括提取根级架构、应用配置文件、链接接口数据字典或从模型架构生成实例。System Composer 模型存储为 SLX 文件。	创建带接口和需求链接的架构模型
组件	组件是系统中可替换的部分，用于在架构环境中实现明确的函数。组件定义架构元素，例如函数、另一个系统、硬件、软件或其他概念实体。组件也可以是子系统或子函数。	组件以模块的形式表示，是架构模型的一部分，并且可以分离成可重用的工件。使用端口接口和参数在组件之间传递信息。可以使用接口编辑器和参数编辑器来配置端口接口和参数。	可视化构建架构
端口	端口是组件或架构上的节点，表示与其环境的交互点。通过端口，信息可以流向其他组件或系统，或者从其他组件或系统流入。	组件端口是组件上与其他组件之间的交互点。架构端口是系统边界上的端口，无论该边界是在组件内还是在整体架构模型内。根架构具有由其端口定义的边界。	可视化构建架构
连接器	连接器是提供端口之间连接的线。连接器描述信息如何在组件或架构之间流动。	通过连接器，两个组件可以进行交互，而无需定义交互的性质。在端口上设置接口来定义组件之间的交互方式。	可视化构建架构

版本历史记录

在 R2019a 中推出

另请参阅

函数

对象

systemcomposer.arch.Element | systemcomposer.arch.Architecture | systemcomposer.arch.Component | systemcomposer.arch.Adapter | systemcomposer.arch.ComponentPort | systemcomposer.arch.ArchitecturePort | systemcomposer.arch.PortElement | systemcomposer.arch.Connector | systemcomposer.arch.PhysicalConnector

模块

Component | Port | Reference Component | Adapter

systemcomposer.arch.BasePort

描述

属性

Name — 端口名称 字符向量

Direction — 端口方向 'Input' | 'Output' | 'Physical' | 'Client' | 'Server'

Parent — 端口所属架构 架构对象

InterfaceName — 与端口关联的接口名称 字符向量

Interface — 与端口相关联的接口 数据接口对象 | 值类型对象 | 物理接口对象 | 服务接口对象

InheritsInterface — 端口是否继承接口 1 (true) | 0 (false)

Connectors — 端口连接器 连接器对象数组

Connected — 端口是否有连接 1 (true) | 0 (false)

Model — 父级 System Composer 模型 模型对象

SimulinkHandle — Simulink 句柄 双精度值

SimulinkModelHandle — 父模型的 Simulink 句柄 双精度值

ExternalUID — 唯一外部标识符 字符向量

UUID — 统一唯一标识符 字符向量

对象函数

示例

以编程方式构建架构模型

详细信息

定义

版本历史记录

另请参阅

函数

对象

模块

主题

`Name` — 端口名称
字符向量

`Direction` — 端口方向
`'Input'` | `'Output'` | `'Physical'` | `'Client'` | `'Server'`

`Parent` — 端口所属架构
架构对象

`InterfaceName` — 与端口关联的接口名称
字符向量

`Interface` — 与端口相关联的接口
数据接口对象 | 值类型对象 | 物理接口对象 | 服务接口对象

`InheritsInterface` — 端口是否继承接口
`1` (`true`) | `0` (`false`)

`Connectors` — 端口连接器
连接器对象数组

`Connected` — 端口是否有连接
`1` (`true`) | `0` (`false`)

`Model` — 父级 System Composer 模型
模型对象

`SimulinkHandle` — Simulink 句柄
双精度值

`SimulinkModelHandle` — 父模型的 Simulink 句柄
双精度值

`ExternalUID` — 唯一外部标识符
字符向量

`UUID` — 统一唯一标识符
字符向量