Documentation Center

  • Trial Software
  • Product Updates

Contents

Simulink.BusElement

Describe element of signal bus

Description

Objects of this class define elements of buses defined by objects of the Simulink.Bus class.

Property Dialog Box

Name

Name of this element. See Signal Names for guidelines for signal names.

Data Type: string

Access: RW

DataType

Name of the data type of this element. The value of this field can be a:

  • Built-in Simulink® data type (for example, double or uint8)

  • Simulink.NumericType object, with one exception. The exception is a Simulink.NumericType whose Category is Fixed-point: unspecified scaling.

      Note:   Fixed-point: unspecified scaling is a partially specified type whose definition is completed by the block that uses the Simulink.NumericType. Forbidding its use for bus elements avoids creating bus elements that have different data types depending on where they are used.

  • Simulink.Bus object, using the Bus: <object name> option. This allows you to create bus objects that specify hierarchical buses (that is, buses that contain other buses).

Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Data type parameter. (See Specify Data Types Using Data Type Assistant.)

Data Type: string

Access: RW

Dimensions

A vector specifying the dimensions of this element.

Data Type: array.

Access: RW

Complexity

Numeric type (real or complex) of this element. Must be real if this bus element is itself a bus.

Data Type: string

Access: RW

SampleTime

Size of the interval between times when this signal value must be recomputed. Must be -1 (inherited) if this bus element is itself a bus or if the bus that includes this element passes through a block that changes the bus's sample time, such as a Rate Transition block. See Specify Sample Time for more information.

Data Type: double

Access: RW

Min

The minimum value of this element. This value must be a finite real double scalar. This value must be empty [] if this element is itself a bus.

Data Type: double

Access: RW

Max

The maximum value of this element. This value must be a finite real double scalar. This value must be empty [] if this element is itself a bus.

Data Type: double

Access: RW

SamplingMode

Sampling mode of this element. Must be sample-based if this element is itself a bus. This field is intended to be used by applications based on Simulink models.

Data Type: string

Access: RW

DimensionsMode

A field that specifies if the size (the number of elements in a dimension) of this element may vary or remain fixed during simulation. This field can have the following values:

  • Fixed: The size of the element may not change during simulation.

  • Variable: The size of the element may change during simulation.

See Variable-Size Signal Basics for more information.

Data Type: string

Access: RW

Units

Measurement units in which this value is expressed (for example, inches). This field is intended for use in documenting this parameter. Simulink ignores it.

Data Type: string

Access: RW

Description

Description of the bus element. This field is intended for use in documenting this parameter. Simulink ignores it.

Data Type: string

Access: RW

Was this topic helpful?