Simulink.BlockData

Provide runtime information about block-related data, such as block parameters

Description

This class defines properties that are common to objects that provide runtime information about a block ports and work vectors.

Parent

None

Children

Simulink.BlockPortData, Simulink.BlockCompDWorkData

Property Summary

Name	Description
`AliasedThroughDataType`	Fundamental base data type.
`AliasedThroughDataTypeID`	Fundamental base data type ID.
`Complexity`	Numeric type (real or complex) of the block data.
`Data`	The block data.
`DataAsDouble`	The block data in `double` form.
`Datatype`	Data type of the block data.
`DatatypeID`	Index of the data type of the block data.
`Dimensions`	Dimensions of the block data.
`Name`	Name of the block data.
`Type`	Type of block data (such as a parameter).

Properties

`AliasedThroughDataType`

Description

Data type aliases allow a data type (B) to be recursively aliased to another alias type or BaseType (A). If alias type A is aliased to another alias type that is aliased to another alias type and so forth, this property allows the alias type to be iteratively searched (aliased through) until the type is no longer an alias type and that final result is the value of the property returned. For example, assume that you have created the Simulink^® Alias types A and B as follows:

A=Simulink.AliasType('double') 
 
A = 
Simulink.AliasType
    Description: ''
     HeaderFile: ''
       BaseType: 'double'
B=Simulink.AliasType('A')

B = 
Simulink.AliasType
    Description: ''
     HeaderFile: ''
       BaseType: 'A'

If the data type of an item of block data is B, this property returns the base type A instead of B.

Data Type

character vector

Access

RO

`AliasedThroughDataTypeID`

Description

Index of the data type alias returned by the AliasedThroughDataType property.

Data Type

integer

Access

RO

`Complexity`

Description

Numeric type (real or complex) of the block data.

Data Type

character vector

Access

RW for MATLAB™ S functions, RO for other blocks.

`Data`

Description

The block data.

Data Type

The data type specified by the Datatype or DatatypeID properties of this object.

Access

RW

`DataAsDouble`

Description

The block data's in double form.

Data Type

double

Access

RO

`Datatype`

Description

Data type of the values of the block-related object.

Data Type

character vector

Access

RO

`DatatypeID`

Description

Index of the data type of the values of the block-related object. enter the numeric value for the desired data type, as follows:

Data Type	Value
`'inherited'`	`-1`
`'double'`	`0`
`'single'`	`1`
`'int8'`	`2`
`'uint8'`	`3`
`'int16'`	`4`
`'uint16'`	`5`
`'int32'`	`6`
`'uint32'`	`7`
`'boolean'` or fixed-point data types	`8`

Data Type

integer

Access

RW for MATLAB S functions, RO for other blocks

`Dimensions`

Description

Dimensions of the block-related object, such as parameter or DWork vector.

Data Type

array

Access

RW for MATLAB S-functions, RO for other blocks

`Name`

Description

Name of block-related object, such as a block parameter or DWork vector.

Data Type

character vector

Access

RW for MATLAB S-functions, RO for other blocks

`Type`

Description

Type of block data. Possible values are:

Type	Description
`'BlockPreCompInputPortData'`	This object contains data for an input port before the model is compiled.
`'BlockPreCompOutputPortData'`	This object contains data for an output port before the model is compiled.
`'BlockCompInputPortData'`	This object contains data for an input port after the model is compiled.
`'BlockCompOutputPortData'`	This object contains data for an output port after the model is compiled.
`'BlockPreCompDworkData'`	This object contains data for a `DWork` vector before the model is compiled.
`'BlockCompDworkData'`	This object contains data for a `DWork` vector after the model is compiled.
`'BlockDialogPrmData'`	This object describes a dialog box parameter of a Level-2 MATLAB S-function.
`'BlockRuntimePrmData'`	This object describes a run-time parameter of a Level-2 MATLAB S-function.
`'BlockCompContStatesData'`	This object describes the continuous states of the block at the current time step.
`'BlockDerivativesData'`	This object describes the derivatives of the block's continuous states at the current time step.

Data Type

character vector

Access

RO

Version History

Introduced before R2006a