Simulink.Bus.createMATLABStruct

创建与总线使用相同的层次结构和属性的 MATLAB 结构体

语法

structs = Simulink.Bus.createMATLABStruct(buses)

structs = Simulink.Bus.createMATLABStruct(buses,values)

structs = Simulink.Bus.createMATLABStruct(buses,values,dims)

structs = Simulink.Bus.createMATLABStruct(buses,values,dims,scope)

说明

structs = Simulink.Bus.createMATLABStruct(buses) 创建一个或多个 MATLAB^® 结构体，这些结构体具有与指定总线相同的层次结构和属性。生成的结构体使用总线的接地值。使用此语法为多个总线端口创建初始化结构体。

structs = Simulink.Bus.createMATLABStruct(buses,values) 创建一个或多个使用指定值的结构体。

structs = Simulink.Bus.createMATLABStruct(buses,values,dims) 创建一个或多个具有指定维度的结构体。要为总线数组创建一个结构体，请使用 dims。

structs = Simulink.Bus.createMATLABStruct(buses,values,dims,scope) 在 scope 指定的数据字典中创建一个或多个结构体。

示例

基于总线对象创建 MATLAB 结构体

打开并仿真模型 ex_bus_initial_conditions。

open_system('ex_bus_initial_conditions')
sim('ex_bus_initial_conditions');

使用 ex_bus_initial_conditions 模型加载的总线对象 Top 创建一个 MATLAB 结构体。

mStruct = Simulink.Bus.createMATLABStruct('Top');

为 mStruct 结构体中与总线 A 的总线元素 A1 对应的字段设置值。

mStruct.A.A1 = 3;
mStruct.A

ans = 

  struct with fields:

    A1: 3
    A2: [5x1 int8]

Simulink 会将该结构体中的其他字段设置为对应的总线元素的接地值。

您可以使用 mStruct 作为 Unit Delay 模块的初始条件结构体。

初始化使用双精度之外的数据类型的信号元素

为其信号元素使用 double 之外的数据类型的总线创建一个 MATLAB 结构体。使用非完全结构体为部分元素指定初始化值。当您创建非完全结构体时，使字段的数据类型与对应元素的数据类型相匹配。

打开并仿真模型 ex_bus_initial_conditions。

open_system('ex_bus_initial_conditions')
sim('ex_bus_initial_conditions');

标签为 Constant5 的模块生成的 C1 信号元素使用数据类型 int16。

查找生成 Top 总线信号的 Bus Creator 模块端口的端口句柄。

ph = get_param('ex_bus_initial_conditions/TopBus','PortHandles');

创建一个非完全结构体，它为 TopBus 模块创建的总线信号中的部分元素指定值。要设置 C.C1 字段的值，请使用定型表达式。使表达式中使用的数据类型与模型中信号元素的数据类型 (int16) 相匹配。

PartialstructForK = struct('B',3,'C',struct('C1',int16(5)));

使用 TopBus 模块的端口句柄 (ph) 创建一个完全结构体。覆盖 C.C1 和 B 元素的接地值。

outPort = ph.Outport;
mStruct = Simulink.Bus.createMATLABStruct(outPort,PartialstructForK);

输出结构体中的字段 C.C1 继续使用数据类型 int16。

创建具有指定维度的 MATLAB 结构体

打开并仿真模型 ex_bus_initial_conditions。

open_system('ex_bus_initial_conditions')
sim('ex_bus_initial_conditions');

创建一个非完全结构体，其中包含 TopBus 模块创建的总线中的部分总线元素。

PartialStructForK = struct('A',struct('A1',4),'B',3)

PartialStructForK = 

  struct with fields:

    A: [1x1 struct]
    B: 3

使用总线对象 Top、非完全结构体以及生成的结构体的维度创建一个 MATLAB 结构体。

structFromBus = Simulink.Bus.createMATLABStruct...
     ('Top',PartialStructForK,[2 3])

structFromBus = 

  2x3 struct array with fields:

    A
    B
    C

创建 MATLAB 结构体元胞数组

要为多个总线端口创建初始化结构体，请将端口句柄指定为 Simulink.Bus.createMATLABStruct 的参量。生成的结构体元胞数组使用接地值。

打开并仿真模型 ex_two_outports_create_struct。

open_system('ex_two_outports_create_struct')
sim('ex_two_outports_create_struct');

查找 Bus Creator 模块 Bus1 和 Bus2 的端口句柄。

ph_1 = get_param...
     ('ex_two_outports_create_struct/Bus Creator','PortHandles');
ph_2 = get_param...
     ('ex_two_outports_create_struct/Bus Creator1','PortHandles');

使用端口句柄数组创建一个 MATLAB® 结构体。

mStruct = Simulink.Bus.createMATLABStruct([ph_1.Outport ph_2.Outport])

mStruct =

  2x1 cell array

    {1x1 struct}
    {1x1 struct}

基于总线端口和非完全结构体创建 MATLAB 结构体

基于与总线信号连接的端口创建一个 MATLAB 结构体。使用非完全结构体为连接该端口的总线中的部分总线元素指定值。

打开并仿真模型 ex_bus_initial_conditions。

open_system('ex_bus_initial_conditions')
sim('ex_bus_initial_conditions');

查找生成 Top 总线信号的 Bus Creator 模块端口的端口句柄。Outport 句柄就是您需要的句柄。

ph = get_param('ex_bus_initial_conditions/TopBus','PortHandles')

ph = 

  struct with fields:

      Inport: [174.0010 175.0009 176.0007]
     Outport: 178.0009
      Enable: []
     Trigger: []
       State: []
       LConn: []
       RConn: []
    Ifaction: []
       Reset: []
       Event: []

创建一个非完全结构体，其中包含 TopBus 模块创建的总线信号。您可以使用非完全结构体为部分总线元素指定值。

PartialstructForK = struct('A',struct('A1',4),'B',3)

PartialstructForK = 

  struct with fields:

    A: [1x1 struct]
    B: 3

由结构体字段 Top.B 和 Top.A 表示的总线元素在总线层次结构中位于同一级别。您可以使用此非完全结构体覆盖 B 和 A 总线信号元素的接地值。

基于总线对象或总线端口创建结构体时，您可以使用非完全结构体作为可选参量。

使用 TopBus 模块的端口句柄 (ph) 创建一个 MATLAB 结构体。覆盖 A.A1 和 B 总线元素的接地值。

outPort = ph.Outport;
mStruct = Simulink.Bus.createMATLABStruct(outPort,PartialstructForK)

mStruct = 

  struct with fields:

    A: [1x1 struct]
    B: 3
    C: [1x1 struct]

输入参数

buses — 总线信息的来源

Simulink.Bus 对象名称 | 端口句柄 | Simulink.Bus 对象名称的元胞数组 | 端口句柄数组

总线信息的来源，指定为 Bus 对象名称、端口句柄、Bus 对象名称元胞数组或端口句柄数组。

• 如果使用 Bus 对象名称，则 Bus 对象必须位于 MATLAB 基础工作区或模型使用的数据字典中。Bus 对象名称的数据类型是 char 或 string。

• 如果您使用端口句柄，则在您使用此函数之前，必须成功编译模型。端口句柄的数据类型是 double。

• 对于总线数组，不能使用端口句柄。

• 如果您使用 dims 参量，则对于 buses 参量，请使用 Bus 对象或 Bus 对象的元胞数组。

如果指定 Bus 对象名称的元胞数组或端口句柄的数组，则只需一次 Simulink.Bus.createMATLABStruct 调用即可创建多个结构体，性能优于使用单独的 Simulink.Bus.createMATLABStruct 调用来创建结构体。

示例: struct = Simulink.Bus.createMATLABStruct('BusObject')

示例: structs = Simulink.Bus.createMATLABStruct({'BusObject','BusObject1'})

示例: struct = Simulink.Bus.createMATLABStruct(portHandle)

示例: structs = Simulink.Bus.createMATLABStruct([portHandle,portHandle1])

数据类型: double | char | string | struct | cell

values — 生成的结构体中元素子集的值

[] | 非完全结构体 | 元胞数组

生成的结构体中元素子集的值，指定为空矩阵 ([])、非完全结构体或元胞数组。对于每个指定的总线信息的来源，元胞数组必须包含一个非完全结构体或空矩阵。

有关创建非完全结构体的信息，请参阅创建用于初始化的非完全结构体。

要使用接地值，请为空矩阵。

示例: struct = Simulink.Bus.createMATLABStruct('BusObject',PartialStruct)

数据类型: struct | cell

dims — 生成的结构体的维度

标量 | 向量 | 元胞数组

生成的结构体的维度，指定为向量。

每个维度元素都必须是大于或等于 1 的整数。如果为 values 参量指定非完全结构体，则每个维度元素必须大于或等于其在非完全结构体中的对应维度元素。

示例: struct = Simulink.Bus.createMATLABStruct('BusObject',PartialStruct,[2 3])

示例: structs = Simulink.Bus.createMATLABStruct({'Bus','Bus1','Bus2'},{[],[],[]},{1,2,3})

数据类型: double | cell

scope — 要包含 MATLAB 结构体的数据字典

Simulink.data.Dictionary 对象

数据字典，指定为 Simulink.data.Dictionary 对象。在使用此参量之前，请使用 Simulink.data.dictionary.create 或 Simulink.data.dictionary.open 等函数通过 Simulink.data.Dictionary 对象来表示字典。

如果 scope 为空，则该函数使用 MATLAB 基础工作区作为 Bus 对象的信源。

示例: structs = Simulink.Bus.createMATLABStruct({'Bus','Bus1','Bus2'},{[],[],[]},{1,1,1},dataDictionaryObject)

输出参量

structs — 与总线具有相同信号层次结构和属性的结构体

MATLAB 结构体 | MATLAB 结构体的元胞数组

与总线具有相同信号层次结构和属性的结构体，以 MATLAB 结构体或 MATLAB 结构体元胞数组形式返回。

结构体维度取决于您指定的输入参量：

• 如果只指定 buses 参量，则维度为 1。

• 如果您还指定 values 参量，则维度与 values 的维度相匹配。

• 如果您指定 dims 参量，则维度与 dims 的维度相匹配。

提示

• 如果您对同一个模型重复使用 Simulink.Bus.createMATLABStruct 函数（例如，在脚本中的循环中），可以通过避免多次编译模型来提高性能。要提高速度，请在多次使用该函数之前对模型进行编译。例如，要编译名为 mymodel 的模型，请使用以下命令。

  mymodel([],[],[],'compile')

  在您创建 MATLAB 结构体后，使用以下命令终止编译：

  mymodel([],[],[],'term')

• 您可以使用类型编辑器来调用 Simulink.Bus.createMATLABStruct 函数。在类型编辑器中，右键点击您要为其创建 MATLAB 结构体的 Simulink.Bus 对象。然后，点击创建 MATLAB 结构体。

  您可以在 MATLAB 编辑器中编辑 MATLAB 结构体。要在此结构体中创建或更新值，请评估代码。

• 您可以使用 Simulink.Bus.createMATLABStruct 函数指定引用模型的输出初始值。

版本历史记录

在 R2010a 中推出

另请参阅

模块

• Bus Assignment | Bus Creator | Bus to Vector

对象

• Simulink.Bus | Simulink.BusElement

函数

• Simulink.Bus.cellToObject | Simulink.Bus.createObject | Simulink.Bus.objectToCell | Simulink.SimulationData.createStructOfTimeseries

主题

• 合成接口规范
• 指定总线元素的初始条件