Structural Properties (Stateflow)

Structural Properties
Structural properties directly or indirectly affect or reflect the hierarchical structure of Stateflow objects within their charts.

See also Structural Methods.

For a key to the abbreviations for object types in the Object column, see Reference Table Column Descriptions.

Property
Type
Acc
Description
Objects

BadIntersection
Boolean
RO
If true, this object graphically intersects another state, box, or function in an invalid way.
S B F

Chart
Chart
RO
Chart object containing this object.
S B F N T J

Decomposition
Enum
RW
Set this property to 'EXCLUSIVE_OR' to specify exclusive (OR) decomposition for the states at the first level of containment in this chart or state. Set to 'PARALLEL_AND' to specify parallel (AND) decomposition for these states. Equivalent to the Decomposition selection in the context menu for this chart or state.
C S

Destination
State or Junction
RW
Destination state or junction of this transition. Assign Destination the destination object for this transition.
You can also use the property Destination to detach the destination end of a transition through the command t.Destination = [] where t is the Transition object.
T

DestinationOClock
Double
RW
Location of transition destination connection on state. Varies from 0 to 12 for full clock cycle location. Value taken as modulus 12 of entered value.
T

Iced
Boolean
RO
Equivalent to property Locked except that this property is used internally to lock this object from being changed during activities such as simulation.
M C

IsGrouped
Boolean
RW
If set to true, group this state.
Nothing is allowed to change inside a grouped state.
This property is also useful for copying states to a new location. See Copying by Grouping (Recommended).
S B F

IsSubchart
Boolean
RW
If set to true, makes this state, box, or function a subchart.
S B F

LabelString
String
RW
Label for this object. Equivalent to typing the label for this object in its label text field in the diagram editor.
S B F T

Locked
Boolean
RW

If set to true, prevents user from changing any Stateflow chart in this machine or chart.
M C

Machine
Machine
RO

Machine that contains this object.
C S B F N T J D E X

MidPoint
Rect
RW

Position of the midpoint of this transition relative to the upper left corner of the Stateflow diagram editor workspace, in a 1-by-2 (x,y) point array.
T

Name
String
RW

Name of this object.

This property is RW except for the name of Machine object, which is RO.
M C S B F D E X

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

Position
Rect
RW
Position and size of this object's box in the Stateflow chart, given in the form of a 1-by-4 array consisting of the following:
(x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace

Width and height of the box

S B F N

Position.
Center
Rect
RW
(x,y) position of junction relative to the upper left vertex of the parent chart or state.
J

Position.
Radius
Double
RW
Radius of this junction.
J

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

Scope
Enum
RW
Scope of this data or event. Allowed values vary with the object containing this data or event and are as follows:

The following apply to any data object:
'LOCAL_DATA' (Local)

'CONSTANT_DATA' (Constant)

'OUTPUT_DATA' (Output to Simulink)

The following apply to data for machines only:
'IMPORTED_DATA' (Exported)

'EXPORTED_DATA' (Imported)

The following apply to data for charts only:
'INPUT_DATA' (Input to Simulink)

The following apply to data for charts and functions only:
'TEMPORARY_DATA' (Temporary)

The following apply to data for functions only:
'FUNCTION_INPUT_DATA' (Input Data)

'FUNCTION_OUTPUT_DATA' (Output Data)

The following apply to any event:
'LOCAL_EVENT' (Local)

The following apply to events for charts only:
'INPUT_EVENT' (Input from Simulink)

'OUTPUT_EVENT' (Output to Simulink)

The following apply to events for machines only:
'IMPORTED_EVENT' (Imported)

'EXPORTED_EVENT' (Exported)

D E

Source
State or Junction
RW
Source state or junction of this transition. Assign Source the source object for this transition.
You can also use the property Source to detach the source end of a transition with the command t.Source = [] where t is the Transition object.
T

SourceEndPoint
Rect
RO*
x,y spatial coordinates for the endpoint of a transition.
*This property can be changed only for default transitions. For all other transitions it is RO (read only).
T

SourceOClock
Double
RW
Location of transition source connection on state. Varies from 0 to 12 for full clock cycle location. Value taken as modulus 12 of entered value.
T

Text
String
RW
Label for this note. The text content for this note that you enter directly into the note in the diagram editor or in the Label field of the Properties dialog for this note.
N

Trigger
Enum
RW
Type of signal that triggers this Input to Simulink or Output to Simulink event associated with its chart. Can be one of the following:
'EITHER_EDGE_EVENT' (Either Edge)

'RISING_EDGE_EVENT' (Rising Edge)

'FALLING_EDGE_EVENT' (Falling Edge)

'FUNCTION_CALL_EVENT' (Function Call)

Equivalent to specifying the indicated parenthetical expression for the Trigger field of the Properties dialog for this event.
E

Type
Enum
RO
Type of this object.
For states, can be one of the following:

'OR' (inclusive)

'AND' (parallel)

The type of a state is determined by the parent's Decomposition property.

For junctions, can be one of the following:
'CONNECTIVE'

'HISTORY'

S J

Property	Type	Acc	Description	Objects
`BadIntersection`	Boolean	RO	If true, this object graphically intersects another state, box, or function in an invalid way.	S B F
`Chart`	Chart	RO	Chart object containing this object.	S B F N T J
`Decomposition`	Enum	RW	Set this property to `'EXCLUSIVE_OR'` to specify exclusive (OR) decomposition for the states at the first level of containment in this chart or state. Set to `'PARALLEL_AND'` to specify parallel (AND) decomposition for these states. Equivalent to the Decomposition selection in the context menu for this chart or state.	C S
`Destination`	State or Junction	RW	Destination state or junction of this transition. Assign `Destination` the destination object for this transition. You can also use the property `Destination` to detach the destination end of a transition through the command `t.Destination = []` where `t` is the Transition object.	T
`DestinationOClock`	Double	RW	Location of transition destination connection on state. Varies from 0 to 12 for full clock cycle location. Value taken as modulus 12 of entered value.	T
`Iced`	Boolean	RO	Equivalent to property `Locked` except that this property is used internally to lock this object from being changed during activities such as simulation.	M C
IsGrouped	Boolean	RW	If set to true, group this state. Nothing is allowed to change inside a grouped state. This property is also useful for copying states to a new location. See Copying by Grouping (Recommended).	S B F
IsSubchart	Boolean	RW	If set to true, makes this state, box, or function a subchart.	S B F
`LabelString`	String	RW	Label for this object. Equivalent to typing the label for this object in its label text field in the diagram editor.	S B F T
`Locked`	Boolean	RW	If set to true, prevents user from changing any Stateflow chart in this machine or chart.	M C
`Machine`	Machine	RO	Machine that contains this object.	C S B F N T J D E X
`MidPoint`	Rect	RW	Position of the midpoint of this transition relative to the upper left corner of the Stateflow diagram editor workspace, in a 1-by-2 (x,y) point array.	T
`Name`	String	RW	Name of this object. This property is RW except for the name of Machine object, which is RO.	M C S B F D E X
`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
`Position`	Rect	RW	Position and size of this object's box in the Stateflow chart, given in the form of a 1-by-4 array consisting of the following: (x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace Width and height of the box	S B F N
`Position.` `Center`	Rect	RW	(x,y) position of junction relative to the upper left vertex of the parent chart or state.	J
`Position.` `Radius`	Double	RW	Radius of this junction.	J
`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
`Scope`	Enum	RW	Scope of this data or event. Allowed values vary with the object containing this data or event and are as follows: The following apply to any data object: `'LOCAL_DATA'` (Local) `'CONSTANT_DATA'` (Constant) `'OUTPUT_DATA'` (Output to Simulink) The following apply to data for machines only: `'IMPORTED_DATA'` (Exported) `'EXPORTED_DATA'` (Imported) The following apply to data for charts only: `'INPUT_DATA'` (Input to Simulink) The following apply to data for charts and functions only: `'TEMPORARY_DATA'` (Temporary) The following apply to data for functions only: `'FUNCTION_INPUT_DATA'` (Input Data) `'FUNCTION_OUTPUT_DATA'` (Output Data) The following apply to any event: `'LOCAL_EVENT'` (Local) The following apply to events for charts only: `'INPUT_EVENT'` (Input from Simulink) `'OUTPUT_EVENT'` (Output to Simulink) The following apply to events for machines only: `'IMPORTED_EVENT'` (Imported) `'EXPORTED_EVENT'` (Exported)	D E
`Source`	State or Junction	RW	Source state or junction of this transition. Assign `Source` the source object for this transition. You can also use the property `Source` to detach the source end of a transition with the command `t.Source = []` where `t` is the Transition object.	T
`SourceEndPoint`	Rect	RO*	x,y spatial coordinates for the endpoint of a transition. *This property can be changed only for default transitions. For all other transitions it is RO (read only).	T
`SourceOClock`	Double	RW	Location of transition source connection on state. Varies from 0 to 12 for full clock cycle location. Value taken as modulus 12 of entered value.	T
`Text`	String	RW	Label for this note. The text content for this note that you enter directly into the note in the diagram editor or in the Label field of the Properties dialog for this note.	N
`Trigger`	Enum	RW	Type of signal that triggers this Input to Simulink or Output to Simulink event associated with its chart. Can be one of the following: `'EITHER_EDGE_EVENT'` (Either Edge) `'RISING_EDGE_EVENT'` (Rising Edge) `'FALLING_EDGE_EVENT'` (Falling Edge) `'FUNCTION_CALL_EVENT'` (Function Call) Equivalent to specifying the indicated parenthetical expression for the Trigger field of the Properties dialog for this event.	E
`Type`	Enum	RO	Type of this object. For states, can be one of the following: `'OR'` (inclusive) `'AND'` (parallel) The type of a state is determined by the parent's `Decomposition` property. For junctions, can be one of the following: `'CONNECTIVE'` `'HISTORY'`	S J

Properties by Use Behavioral Properties