Simulink.Bus.createMATLABStruct

Open and compile the example model named BusInitialization. Compiling the model updates the line styles, which you can use to visually identify buses.

mdl = "BusInitialization";
open_system(mdl)
set_param(mdl,SimulationCommand="Update")

A preload callback in the model loads Simulink.Bus objects such as TopBus. The bus that passes through the Unit Delay block uses this bus object.

Create a MATLAB structure that has the same hierarchy and attributes as TopBus. Name the structure mstruct.

mstruct = Simulink.Bus.createMATLABStruct("TopBus")

mstruct = struct with fields:
    A: [1x1 struct]
    B: 0
    C: [1x1 struct]

The function assigns a ground value of 0 to each field in the structure.

Specify a value of 3 for the field that corresponds with TopBus.A.A1.

mstruct.A.A1 = 3;

The other fields in the structure continue to specify a value of 0.

To specify mstruct as the initial condition structure for the Unit Delay block, set the Initial condition block parameter to mstruct.

To create initialization structures for buses at multiple ports, use multiple port handles with the Simulink.Bus.createMATLABStruct function. The resulting cell array of structures uses ground values.

Open and compile the example model named BusInitializationTwoPorts.

mdl = "BusInitializationTwoPorts";
open_system(mdl)
set_param(mdl,SimulationCommand="Update")

Get the handle of the output port for each Bus Creator block.

bc1 = "BusInitializationTwoPorts/Bus Creator";
ph1 = get_param(bc1,"PortHandles");
out1 = ph1.Outport;

bc2 = "BusInitializationTwoPorts/Bus Creator1";
ph2 = get_param(bc2,"PortHandles");
out2 = ph2.Outport;

To create a cell array that contains a structure for each bus, provide an array of port handles to the Simulink.Bus.createMATLABStruct function.

structs = Simulink.Bus.createMATLABStruct([out1 out2])

structs=2×1 cell array
    {1x1 struct}
    {1x1 struct}

Create a MATLAB structure based on a port that corresponds with a bus. Use a partial structure to specify values for a subset of the bus elements in the bus that connects to the port.

Open and compile the example model named BusInitialization. Compiling the model updates the line styles, which you can use to visually identify buses.

mdl = "BusInitialization";
open_system(mdl)
set_param(mdl,SimulationCommand="Update")

Create a partial structure that specifies values for a subset of the elements in the bus hierarchy. In the partial structure, specify values for the Top.A.A1 and Top.B elements.

pstruct = struct("A",struct("A1",4),"B",3)

pstruct = struct with fields:
    A: [1x1 struct]
    B: 3

To create a full structure, use the Simulink.Bus.createMATLABStruct function.

For the first input argument, get the handle of the Bus Creator block output port that produces the top-level bus.

bctop = "BusInitialization/Bus Creator3";
ph = get_param(bctop,"PortHandles");
out = ph.Outport;

For the second input argument, specify the partial structure. The partial structure overrides the ground values for the Top.A.A1 and Top.B elements.

fstruct = Simulink.Bus.createMATLABStruct(out,pstruct)

fstruct = struct with fields:
    A: [1x1 struct]
    B: 3
    C: [1x1 struct]

Create a MATLAB structure for a bus whose signal elements use a data type other than double. Use a partial structure to specify initialization values for a subset of the elements. When you create the partial structure, match the data types of the fields with the data types of the corresponding elements.

Open and compile the example model named BusInitialization. Compiling the model updates the line styles, which you can use to visually identify buses.

mdl = "BusInitialization";
open_system(mdl)
set_param(mdl,SimulationCommand="Update")

Create a partial structure that specifies values for a subset of the elements in the bus hierarchy. In the partial structure, specify values for the elements Top.B and Top.C.C1.

The signal element Top.C.C1 uses the data type int16. To set the value of the C.C1 field of the structure, use a typed expression. Match the data type in the expression with the data type of the signal in the model.

pstruct = struct("B",3,"C",struct("C1",int16(5)));

To create a full structure, use the Simulink.Bus.createMATLABStruct function.

For the first input argument, get the port handle for the Bus Creator block output port that produces the top-level bus.

bctop = "BusInitialization/Bus Creator3";
ph = get_param(bctop,"PortHandles");
out = ph.Outport;

For the second input argument, specify the partial structure. The partial structure overrides the ground values for the Top.C.C1 and Top.B elements.

fstruct = Simulink.Bus.createMATLABStruct(out,pstruct);

Check the value of fstruct.C.C1.

fstruct.C.C1

ans = int16

5

This field uses the data type int16.

Open and compile the example model named BusInitialization. Compiling the model updates the line styles, which you can use to visually identify buses.

mdl = "BusInitialization";
open_system(mdl)
set_param(mdl,SimulationCommand="Update")

A preload callback in the model loads Simulink.Bus objects such as TopBus. The bus that passes through the Unit Delay block uses this bus object.

Create a partial structure for a subset of the bus elements in the top-level bus.

pstruct = struct("A",struct("A1",4),"B",3)  

pstruct = struct with fields:
    A: [1x1 struct]
    B: 3

Create a full structure using the Simulink.Bus object named TopBus, the partial structure named pstruct, and the dimensions for the resulting structure.

fstruct = Simulink.Bus.createMATLABStruct("TopBus",...
    pstruct,[2 3])

fstruct=2×3 struct array with fields:
    A
    B
    C