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

Stateflow User's Guide

Debugging Properties

The following properties control values used in debugging Stateflow applications with the Stateflow Debugger.

Property
Type
Acc
Description
Objects

Debug.
Animation.
Delay
Double
RW
Specify a delay (slow down) value for animation. Equivalent to setting the Delay (sec) field in the Animation section of the Debugger window.
M

Debug.
Animation.
Enabled
Boolean
RW
If set to true, animation (simulation) is enabled. If false (=0), disabled. Equivalent to selecting the Enabled or Disabled radio button of the Animation section of the Debugger window.
M

Debug.
BreakOn.
ChartEntry
Boolean
RW
If set to true, set the chart entry breakpoint for all charts in this machine. Equivalent to selecting the Chart Entry check box on the Debugger window.
M

Debug.
BreakOn.
EventBroadcast
Boolean
RW
If set to true, set the event broadcast breakpoint for all charts in this machine. Equivalent to selecting the Event Broadcast check box on the Debugger window.
M

Debug.
BreakOn.
StateEntry
Boolean
RW
If set to true, set the state entry breakpoint for all states in this machine. Equivalent to selecting the State Entry check box on the Debugger window.
M

Debug.
Breakpoints.
EndBroadcast
Boolean
RW
If set to true, set a debugger breakpoint for the end of the broadcast of this event. Equivalent to selecting the End of broadcast check box in the Properties dialog for this event.
E

Debug.
Breakpoints.
StartBroadcast
Boolean
RW
If set to true, set a debugger breakpoint for the start of the broadcast of this event. Equivalent to selecting the Start of broadcast check box in the properties dialog for this event.
E

Debug.
Breakpoints.
onDuring
Boolean
RW
If set to true, set the state during breakpoint for this chart. Equivalent to selecting the State During check box in the properties dialog for this state.
S

Debug.
Breakpoints.
OnEntry
Boolean
RW
If set to true, set the entry breakpoint for this object. Equivalent to selecting the Chart Entry or State Entry check box in the properties dialog for this chart or state, respectively.
C S

Debug.
Breakpoints.
OnExit
Boolean
RW
If set to true, set the state entry breakpoint for this object. Equivalent to selecting the State Exit check box in the properties dialog for this object.
S

Debug.
Breakpoints.
WhenTested
Boolean
RW
If set to true, set a debugging breakpoint to occur when this transition is tested to see if it is a valid transition. Equivalent to selecting the When Tested check box in the properties dialog of this transition.
T

Debug.
Breakpoints.
WhenValid
Boolean
RW
If set to true, set a debugging breakpoint to occur when this transition has tested as valid. Equivalent to selecting the When Valid check box in the Properties dialog of this transition.
T

Debug.
DisableAll
Breakpoints
Boolean
RW
If set to true, disables the use of all breakpoints in this machine. Equivalent to selecting the Disable all check box in the Debugger window.
M

Debug.
RunTimeCheck.
State
Inconsistencies
Boolean
RW
If set to true, check for state inconsistencies during a debug session. Equivalent to selecting the State Inconsistency check box in the Debugger window.
M

Debug.
RunTimeCheck.
TransitionConflicts
Boolean
RW
If set to true, check for transition conflicts during a debug session. Equivalent to selecting the Transition Conflict check box in the Debugger window.
M

Debug.
RunTimeCheck.
CycleDetection
Boolean
RW
If set to true, check for cyclical behavior errors during a debug session. Equivalent to selecting the Detect Cycles check box in the Debugger window.
M

Debug.
RunTimeCheck.
DataRangeChecks
Boolean
RW
If set to true, check for data range violations during a debug session. Equivalent to selecting the Data Range check box in the Debugger window.
M

Debug.
Watch
Boolean
RW
If set to true, cause the debugger to halt execution if this data is modified. Setting this property to true is equivalent to selecting the Watch column entry for this data in the Explorer or selecting the Watch in debug check box in the Properties dialog for this data.
D

IsTestPoint
Boolean
RW
If set to true (default = false), sets this data or state as a Stateflow test point. You can monitor individual Stateflow test points with a floating scope during model simulation. You can also log test point values into MATLAB workspace objects. See Monitoring Stateflow Test Points in the Stateflow and Stateflow Coder User's Guide documentation for details.
S D

Property	Type	Acc	Description	Objects
`Debug.` `Animation.` `Delay`	Double	RW	Specify a delay (slow down) value for animation. Equivalent to setting the Delay (sec) field in the Animation section of the Debugger window.	M
`Debug.` `Animation.` `Enabled`	Boolean	RW	If set to true, animation (simulation) is enabled. If false (=0), disabled. Equivalent to selecting the Enabled or Disabled radio button of the Animation section of the Debugger window.	M
`Debug.` `BreakOn.` `ChartEntry`	Boolean	RW	If set to true, set the chart entry breakpoint for all charts in this machine. Equivalent to selecting the Chart Entry check box on the Debugger window.	M
`Debug.` `BreakOn.` `EventBroadcast`	Boolean	RW	If set to true, set the event broadcast breakpoint for all charts in this machine. Equivalent to selecting the Event Broadcast check box on the Debugger window.	M
`Debug.` `BreakOn.` `StateEntry`	Boolean	RW	If set to true, set the state entry breakpoint for all states in this machine. Equivalent to selecting the State Entry check box on the Debugger window.	M
`Debug.` `Breakpoints.` `EndBroadcast`	Boolean	RW	If set to true, set a debugger breakpoint for the end of the broadcast of this event. Equivalent to selecting the End of broadcast check box in the Properties dialog for this event.	E
`Debug.` `Breakpoints.` `StartBroadcast`	Boolean	RW	If set to true, set a debugger breakpoint for the start of the broadcast of this event. Equivalent to selecting the Start of broadcast check box in the properties dialog for this event.	E
`Debug.` `Breakpoints.` `onDuring`	Boolean	RW	If set to true, set the state during breakpoint for this chart. Equivalent to selecting the State During check box in the properties dialog for this state.	S
`Debug.` `Breakpoints.` `OnEntry`	Boolean	RW	If set to true, set the entry breakpoint for this object. Equivalent to selecting the Chart Entry or State Entry check box in the properties dialog for this chart or state, respectively.	C S
`Debug.` `Breakpoints.` `OnExit`	Boolean	RW	If set to true, set the state entry breakpoint for this object. Equivalent to selecting the State Exit check box in the properties dialog for this object.	S
`Debug.` `Breakpoints.` `WhenTested`	Boolean	RW	If set to true, set a debugging breakpoint to occur when this transition is tested to see if it is a valid transition. Equivalent to selecting the When Tested check box in the properties dialog of this transition.	T
`Debug.` `Breakpoints.` `WhenValid`	Boolean	RW	If set to true, set a debugging breakpoint to occur when this transition has tested as valid. Equivalent to selecting the When Valid check box in the Properties dialog of this transition.	T
`Debug.` `DisableAll` `Breakpoints`	Boolean	RW	If set to true, disables the use of all breakpoints in this machine. Equivalent to selecting the Disable all check box in the Debugger window.	M
`Debug.` `RunTimeCheck.` `State` `Inconsistencies`	Boolean	RW	If set to true, check for state inconsistencies during a debug session. Equivalent to selecting the State Inconsistency check box in the Debugger window.	M
`Debug.` `RunTimeCheck.` `TransitionConflicts`	Boolean	RW	If set to true, check for transition conflicts during a debug session. Equivalent to selecting the Transition Conflict check box in the Debugger window.	M
`Debug.` `RunTimeCheck.` `CycleDetection`	Boolean	RW	If set to true, check for cyclical behavior errors during a debug session. Equivalent to selecting the Detect Cycles check box in the Debugger window.	M
`Debug.` `RunTimeCheck.` `DataRangeChecks`	Boolean	RW	If set to true, check for data range violations during a debug session. Equivalent to selecting the Data Range check box in the Debugger window.	M
`Debug.` `Watch`	Boolean	RW	If set to true, cause the debugger to halt execution if this data is modified. Setting this property to true is equivalent to selecting the Watch column entry for this data in the Explorer or selecting the Watch in debug check box in the Properties dialog for this data.	D
IsTestPoint	Boolean	RW	If set to `true` (default = `false`), sets this data or state as a Stateflow test point. You can monitor individual Stateflow test points with a floating scope during model simulation. You can also log test point values into MATLAB workspace objects. See Monitoring Stateflow Test Points in the Stateflow and Stateflow Coder User's Guide documentation for details.	S D

Data Definition Properties Identifiers