Data Definition Properties :: API Properties and Methods by Use (Stateflow User's Guide)

Stateflow User's Guide

Data Definition Properties

The following properties control the type, size, and value of data in Stateflow diagrams.

Property
Return
Access
Description
Objects

DataType
Enum
RW
Data type of this data. Can have one of the following possible values: 'boolean', 'uint8', 'int8', 'uint16', 'int16', 'uint32', 'int32', 'single', 'double' and 'fixpt'. Equivalent to an entry in the Type column for this data in Explorer or the Type field in the properties dialog for this data.
D

FixptType.
Bias
Double
RW
The Bias value for this fixed-point type.
D

FixptType.
FractionalSlope
Double
RW
The Fractional Slope value for this fixed-point type.
D

FixptType.
RadixPoint
Integer
RW
The power of two specifying the binary point location for this fixed-point type.
D

FixptType.
BaseType
Enum
RW
The size and sign of the base for the quantized integer, Q, of this fixed-point type.
D

ParsedInfo.
Array.
Size
Integer
RO
Numeric equivalent of string Data property Props.Array.Size.
D

ParsedInfo.
Array.
FirstIndex
Integer
RO
Numeric equivalent of string Data property Props.Range.FirstIndex.
D

ParsedInfo.
InitialValue
Double
RO
Numeric equivalent of string Data property Props.InitialValue.
D

ParsedInfo.
Range.
Maximum
Double
RO
Numeric equivalent of string Data property Props.Range.Maximum.
D

ParsedInfo.
Range.
Minimum
Double
RO
Numeric equivalent of string Data property Props.Range.Minimum.
D

Port
Integer
RW
Port index number for this input or output data or event (default = 1).
D E

Props.
Array.
Size
String
RW
Specifying a positive value for this property specifies that this data is an array of specified size. Equivalent to entering a positive value in the Size column for this data in the Explorer or in the Sizes field of the properties dialog for this data.
D

Props.
Array.
FirstIndex
String
RW
Index of the first element of this data if it is an array (Props.Array.Size >= 1). Equivalent to entering a value of zero or greater in the First Index field of the Properties dialog for this data.
D

Props.
InitialValue
String
RW
If the source of the initial value for this data is the Stateflow data dictionary, this is the value used. Equivalent to entering this value in the InitVal column for this data in the Explorer or similar field in the Properties dialog for this data.
D

Props.
Range.
Maximum
String
RW
Maximum value that this data can have during execution or simulation of the state machine. Equivalent to entering value in Max column for this data in Explorer or the Max field in the Properties dialog for this data.
D

Props.
Range.
Minimum
String
RW
Minimum value that this data can have during execution or simulation of the state machine. Equivalent to entering value in the Min column for this data in Explorer or in the Min field in the properties dialog for this data.
D

SaveToWorkspace
Boolean
RW
If set to true, this data is saved to the MATLAB workspace. Equivalent to selecting the ToWS column entry for this data in the Explorer or selecting the Save final value to base workspace field in the properties dialog for this data.
D

Units
String
RW
Physical units corresponding to the value of this data object.
D

Property	Return	Access	Description	Objects
`DataType`	Enum	RW	Data type of this data. Can have one of the following possible values: `'boolean'`, `'uint8'`, `'int8'`, `'uint16'`, `'int16'`, `'uint32'`, `'int32'`, `'single'`, `'double'` and `'fixpt'`. Equivalent to an entry in the Type column for this data in Explorer or the Type field in the properties dialog for this data.	D
FixptType. Bias	Double	RW	The Bias value for this fixed-point type.	D
FixptType. `FractionalSlope`	Double	RW	The Fractional Slope value for this fixed-point type.	D
FixptType. `RadixPoint`	Integer	RW	The power of two specifying the binary point location for this fixed-point type.	D
FixptType. `BaseType`	Enum	RW	The size and sign of the base for the quantized integer, Q, of this fixed-point type.	D
`ParsedInfo.` `Array.` `Size`	Integer	RO	Numeric equivalent of string Data property `Props.Array.Size`.	D
`ParsedInfo.` `Array.` `FirstIndex`	Integer	RO	Numeric equivalent of string Data property `Props.Range.FirstIndex`.	D
`ParsedInfo.` `InitialValue`	Double	RO	Numeric equivalent of string Data property `Props.InitialValue`.	D
`ParsedInfo.` `Range.` `Maximum`	Double	RO	Numeric equivalent of string Data property `Props.Range.Maximum`.	D
`ParsedInfo.` `Range.` `Minimum`	Double	RO	Numeric equivalent of string Data property `Props.Range.Minimum`.	D
Port	Integer	RW	Port index number for this input or output data or event (default = `1`).	D E
`Props.` `Array.` `Size`	String	RW	Specifying a positive value for this property specifies that this data is an array of specified size. Equivalent to entering a positive value in the Size column for this data in the Explorer or in the Sizes field of the properties dialog for this data.	D
`Props.` `Array.` `FirstIndex`	String	RW	Index of the first element of this data if it is an array (`Props.Array.Size >= 1`). Equivalent to entering a value of zero or greater in the First Index field of the Properties dialog for this data.	D
`Props.` `InitialValue`	String	RW	If the source of the initial value for this data is the Stateflow data dictionary, this is the value used. Equivalent to entering this value in the InitVal column for this data in the Explorer or similar field in the Properties dialog for this data.	D
`Props.` `Range.` `Maximum`	String	RW	Maximum value that this data can have during execution or simulation of the state machine. Equivalent to entering value in Max column for this data in Explorer or the Max field in the Properties dialog for this data.	D
`Props.` `Range.` `Minimum`	String	RW	Minimum value that this data can have during execution or simulation of the state machine. Equivalent to entering value in the Min column for this data in Explorer or in the Min field in the properties dialog for this data.	D
`SaveToWorkspace`	Boolean	RW	If set to true, this data is saved to the MATLAB workspace. Equivalent to selecting the ToWS column entry for this data in the Explorer or selecting the Save final value to base workspace field in the properties dialog for this data.	D
`Units`	String	RW	Physical units corresponding to the value of this data object.	D

Containment Debugging Properties