Simulink.Bus.createObject
Create Simulink.Bus objects from blocks or MATLAB
structures
Syntax
Description
busInfo = Simulink.Bus.createObject(mdl,busSource)Simulink.Bus objects for the buses specified by
busSource in the model specified by
mdl. The function returns information about the created
objects.
When the model uses a data dictionary, this function creates the objects in the data dictionary. Otherwise, this function creates the objects in the base workspace.
busInfo = Simulink.Bus.createObject(S)Simulink.Bus objects from the structure specified by
S. The structure can contain MATLAB®
timeseries, MATLAB
timetable, and
matlab.io.datastore.SimulationDatastore objects. The
structure can be a numeric structure.
The function creates the objects in the base workspace.
busInfo = Simulink.Bus.createObject(___,file,fileFormat)fileFormat is "object", saves the
Simulink.Bus object definitions using arrays. The
"object" format makes the function easier to read. The
default for fileFormat is "cell", which uses
cell arrays and is more compact.
busInfo = Simulink.Bus.createObject(S,file,fileFormat,scope)Simulink.Bus objects in the data dictionary specified
by scope.
Examples
Create Simulink.Bus objects from a Bus Creator block that creates a bus with multiple levels of hierarchy.
Open the example model named BusHierarchy.
mdl = "BusHierarchy";
open_system(mdl)
Create a Simulink.Bus object from the Bus Creator block named Bus Creator1. This block receives input from a source block and another Bus Creator block.
block = "BusHierarchy/Bus Creator1";
busInfo = Simulink.Bus.createObject(mdl,block);This command creates Simulink.Bus objects named TopBus and NestedBus in the base workspace. Each bus object represents a bus in the bus hierarchy.
To view the Simulink.Bus objects, open the Type Editor.
typeeditor
Create Simulink.Bus objects from a bus element port, which Out Bus Element blocks represent.
Open the example model named BusOutput.
mdl = "BusOutput";
open_system(mdl)
The output bus has multiple levels of hierarchy. The top-level bus contains a nested bus.
Create Simulink.Bus objects that define the bus hierarchy at the output port named OutBus.
port = "BusOutput/OutBus";
busInfo = Simulink.Bus.createObject(mdl,port);To view the objects, open the Type Editor.
typeeditor
Create Simulink.Bus objects from a Bus Creator block and save the Simulink.Bus object definitions in a function.
Open the example model named BusHierarchy.
mdl = "BusHierarchy";
open_system(mdl);
Create Simulink.Bus objects from the Bus Creator block named Bus Creator1. This block receives input from a source block and another Bus Creator block. To save the Simulink.Bus object definitions in a function, also specify a filename.
block = "BusHierarchy/Bus Creator1"; file = "BusObjectFunction"; busInfo = Simulink.Bus.createObject(mdl,block,file);
These commands create Simulink.Bus objects named TopBus and NestedBus in the base workspace and a file named BusObjectFunction in your current folder.
To examine the file contents, open the file. By default, the file uses the "cell" format. For example, the Chirp element is defined by a cell array.
{'Chirp', 1, 'double', 'real', 'Sample', 'Fixed', [], [], '', ''};
For a file that is formatted to be easier to read, specify the file format as "object".
file1 = "BusObjectFunctionFormatted"; busInfo1 = Simulink.Bus.createObject(mdl,block,file1,"object");
To examine the file contents, open the file. In the "object" format, the Chirp element is defined by an array that uses dot notation to assign property values.
elems(1) = Simulink.BusElement; elems(1).Name = 'Chirp'; elems(1).Dimensions = 1; elems(1).DimensionsMode = 'Fixed'; elems(1).DataType = 'double'; elems(1).Complexity = 'real'; elems(1).Min = []; elems(1).Max = []; elems(1).DocUnits = ''; elems(1).Description = '';
When you create a nonvirtual bus with a Constant block, you must specify a MATLAB structure for Constant value and a Simulink.Bus object as the Output data type.
For this example, create a structure that contains other structures.
bus_struct.A.A1 = 0; bus_struct.A.A2 = [0 + 0i;0 + 0i;0 + 0i;0 + 0i;0 + 0i]; bus_struct.B = 5; bus_struct.C.C1 = 0; bus_struct.C.C2.A1 = 0; bus_struct.C.C2.A2 = [0 + 0i;0 + 0i;0 + 0i;0 + 0i;0 + 0i];
Create the Simulink.Bus objects that correspond with the structure.
busInfo = Simulink.Bus.createObject(bus_struct);
The function creates four Simulink.Bus objects. The object named slBus1 corresponds to the top-level structure and uses a default name. The objects named A, C, and C2 correspond to the nested structures.
To view the objects, open the Type Editor.
typeeditor
