Simulink.Bus (Simulink Reference)

Specify the properties of a signal bus

Description

Objects of this class (in conjunction with objects of the Simulink.BusElement class) specify the properties of a signal bus. You can use these objects to enable Simulink to check the validity of buses connected to the inputs of blocks in your model. You do this by entering the name of a bus object defining a bus in the Bus object field of a block's parameter dialog box. When you update the model's diagram or start a simulation of the model, Simulink checks whether the buses connected to the blocks have the properties specified by the bus objects. If not, Simulink halts and displays an error message.

You can use the Model Explorer (see The Model Explorer), the Simulink Bus Editor (see Bus Editor), or MATLAB commands (see Working with Data Objects) to create bus objects. You must use the Bus Editor or the MATLAB command line to set the properties of a bus object.

Property Dialog Box

Bus elements: Table that displays the properties of the bus's elements. You cannot edit this table. You must use either the Simulink Bus Editor (see Bus Editor in the online Simulink documentation) or MATLAB commands to add or delete bus elements or change the properties of existing bus elements. To launch the bus editor, click the Launch Bus Editor button at the bottom of this dialog box or select Bus Editor from the model editor's Tools menu.
Header file: Name of a C header file that declares the structure of this bus. This field is intended for use by Real-Time Workshop. Simulink ignores it.
Description: Description of this structure. This field is intended for you to use to document this bus. Simulink itself does not use this field.

Properties

Name
Access
Description

Description
RW
String that describes this bus. This property is intended for user use. Simulink itself does not use it. (Description)

Elements
RW
An array of Simulink.BusElement objects that define the names, data types, dimensions, and other properties of the bus's elements. The elements must have unique names. (Bus elements)

HeaderFile
RW
String that specifies the name of a C header file that declares the structure of this bus. This property is intended for use by Real-Time Workshop. Simulink does not use it. (Header file)

Name	Access	Description
`Description`	`RW`	String that describes this bus. This property is intended for user use. Simulink itself does not use it. (Description)
`Elements`	`RW`	An array of `Simulink.BusElement` objects that define the names, data types, dimensions, and other properties of the bus's elements. The elements must have unique names. (Bus elements)
`HeaderFile`	`RW`	String that specifies the name of a C header file that declares the structure of this bus. This property is intended for use by Real-Time Workshop. Simulink does not use it. (Header file)

See Also

Simulink.BusElement

Simulink.BlockPreCompOutputPortData Simulink.BusElement