Interface to Simulink :: API Properties and Methods by Use (Stateflow User's Guide)

Stateflow User's Guide

Interface to Simulink

The following properties and (methods) control how data and events are input from and output to the Simulink model for a Stateflow chart.

Property (Method)
Type
Acc
Description
Objects

ChartUpdate
Enum
RW
Activation method of this chart. Can be one of the following:
'INHERITED' (Triggered or Inherited)

'DISCRETE' (Sampled)

'CONTINUOUS' (Continuous)

These preceding entries are equivalent to the parenthetical entries for the Update method field in the Properties dialog for this chart.
C

ExecuteAt
Initialization
Boolean
RW
If set to true, initialize this chart's state configuration at time zero instead of first input event. Equivalent to selecting the Execute (enter) Chart at Initialization check box in the chart properties dialog.
C

ExportChart
Functions
Boolean
RW
If set to true (default = false), graphical functions at chart level are made global. Equivalent to selecting the Export Chart Level Graphical Functions (Make Global) check box in the chart properties dialog.
C

(outputData)
No Return
NA
Output the activity status of this state to Simulink via a data output port on the Chart block of this state.
S

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

SampleTime
String
RW
Sample time for activating this chart. Applies only when the ChartUpdate property for this chart is set to 'DISCRETE'
( = Sampled in the Update method field in the Properties dialog for this chart).
C

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

Scope
Enum
RW
Scope of this data. Allowed values vary with the object containing this data, which are as follows:
'Local'

'Constant'

'Imported' (machine objects only)

'Exported' (machine objects only)

'Input' (chart objects only)

'Output' (chart objects only)

'Temporary' (function objects only)

'Function input' (function objects only)

'Function output' (function objects only)

Above values correspond to entries in the Scope field of the Data or Event dialog.
D E

StrongDataTyping
WithSimulink
Boolean
RW
If set to true, set strong data typing with Simulink I/O. Equivalent to the Use Strong Data Typing with Simulink I/O check box in the chart properties dialog.
C

Trigger
Enum
RW
Type of signal that triggers this chart input event. Also the type of trigger associated with this chart output event.
The following triggers apply to both chart input and output events:
'Either' (Either Edge)

'Function call' (Function Call)

The following triggers apply only to chart input events:
'Rising' (Rising Edge)

'Falling' (Falling Edge)

The preceding entries are equivalent to the entries in parentheses for the Trigger field in the Event dialog for this event.
E

Property (Method)	Type	Acc	Description	Objects
`ChartUpdate`	Enum	RW	Activation method of this chart. Can be one of the following: `'INHERITED'` (Triggered or Inherited) `'DISCRETE'` (Sampled) `'CONTINUOUS'` (Continuous) These preceding entries are equivalent to the parenthetical entries for the Update method field in the Properties dialog for this chart.	C
`ExecuteAt` `Initialization`	Boolean	RW	If set to true, initialize this chart's state configuration at time zero instead of first input event. Equivalent to selecting the Execute (enter) Chart at Initialization check box in the chart properties dialog.	C
`ExportChart` `Functions`	Boolean	RW	If set to `true` (default = `false`), graphical functions at chart level are made global. Equivalent to selecting the Export Chart Level Graphical Functions (Make Global) check box in the chart properties dialog.	C
(outputData)	No Return	NA	Output the activity status of this state to Simulink via a data output port on the Chart block of this state.	S
Port	Integer	RW	Port index number for this input or output data or event (default = `1`).	D E
`SampleTime`	String	RW	Sample time for activating this chart. Applies only when the `ChartUpdate` property for this chart is set to `'DISCRETE'` ( = Sampled in the Update method field in the Properties dialog for this chart).	C
`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
`Scope`	Enum	RW	Scope of this data. Allowed values vary with the object containing this data, which are as follows: `'Local'` `'Constant'` `'Imported'` (machine objects only) `'Exported'` (machine objects only) `'Input'` (chart objects only) `'Output'` (chart objects only) `'Temporary'` (function objects only) `'Function input'` (function objects only) `'Function output'` (function objects only) Above values correspond to entries in the Scope field of the Data or Event dialog.	D E
`StrongDataTyping` `WithSimulink`	Boolean	RW	If set to true, set strong data typing with Simulink I/O. Equivalent to the Use Strong Data Typing with Simulink I/O check box in the chart properties dialog.	C
`Trigger`	Enum	RW	Type of signal that triggers this chart input event. Also the type of trigger associated with this chart output event. The following triggers apply to both chart input and output events: `'Either'` (Either Edge) `'Function call'` (Function Call) The following triggers apply only to chart input events: `'Rising'` (Rising Edge) `'Falling'` (Falling Edge) The preceding entries are equivalent to the entries in parentheses for the Trigger field in the Event dialog for this event.	E

Identifiers Machine (Model) Identifier Properties