StateFlow UserGuide
StateFlow UserGuide
User's Guide
R2017a
How to Contact MathWorks
Phone: 508-647-7000
Bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
v
States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
What Is a State? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
State Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
State Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
State Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
What Is a Transition? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
Transition Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Transition Label Notation . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Valid Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
vi Contents
History Junctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46
What Is a History Junction? . . . . . . . . . . . . . . . . . . . . . . . . 2-46
History Junctions and Inner Transitions . . . . . . . . . . . . . . . 2-47
Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
What Is a Box? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
Example of Using a Box . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48
vii
How Events Drive Chart Execution . . . . . . . . . . . . . . . . . . . 3-43
How Stateflow Charts Respond to Events . . . . . . . . . . . . . . 3-43
Sources for Stateflow Events . . . . . . . . . . . . . . . . . . . . . . . . 3-43
How Charts Process Events . . . . . . . . . . . . . . . . . . . . . . . . 3-44
viii Contents
Example of Early Return Logic . . . . . . . . . . . . . . . . . . . . . . 3-86
ix
Select and Deselect Graphical Objects . . . . . . . . . . . . . . . . . 4-38
Cut and Paste Graphical Objects . . . . . . . . . . . . . . . . . . . . 4-38
Copy Graphical Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Comment Out Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Format Chart Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Generate a Model Report . . . . . . . . . . . . . . . . . . . . . . . . . . 4-54
x Contents
Build Mealy and Moore Charts
6
Overview of Mealy and Moore Machines . . . . . . . . . . . . . . . . 6-2
Semantics of Mealy and Moore Machines . . . . . . . . . . . . . . . 6-2
Model with Mealy and Moore Machines . . . . . . . . . . . . . . . . 6-3
Default State Machine Type . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Availability of Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Advantages of Mealy and Moore Charts . . . . . . . . . . . . . . . . 6-3
xi
Create a History Junction . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Change History Junction Size . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Change History Junction Properties . . . . . . . . . . . . . . . . . . . 7-3
xii Contents
Export Chart-Level Functions . . . . . . . . . . . . . . . . . . . . . . . 7-35
Define Data
8
Add Stateflow Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Add Data from the Stateflow Editor . . . . . . . . . . . . . . . . . . . 8-2
Add Data Through the Model Explorer . . . . . . . . . . . . . . . . . 8-3
xiii
Initialize Data from the MATLAB Base Workspace . . . . . . . 8-25
Save Data to the MATLAB Workspace . . . . . . . . . . . . . . . . 8-26
How Charts Work with Local and Global Data Stores . . . . 8-28
xiv Contents
Examples of Valid Data Size Expressions . . . . . . . . . . . . . . 8-47
Name Conflict Resolution for Variables in Size Expressions . 8-47
Best Practices for Sizing Stateflow Data . . . . . . . . . . . . . . . 8-47
Define Events
9
How Events Work in Stateflow Charts . . . . . . . . . . . . . . . . . . 9-2
What Is an Event? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
xv
When to Use Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Types of Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Where You Can Use Events . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Diagnostic for Detecting Unused Events . . . . . . . . . . . . . . . . 9-3
xvi Contents
Best Practices for Using Events in Stateflow Charts . . . . . 9-40
Messages
10
How Messages Work in Stateflow Charts . . . . . . . . . . . . . . . 10-2
xvii
Use Actions in Charts
11
State Action Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Entry Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Exit Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
During Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Bind Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
On Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
xviii Contents
Time Symbol, t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
xix
How Sample Time Affects Chart Execution . . . . . . . . . . . . 11-70
Best Practices for Absolute-Time Temporal Logic . . . . . . . 11-71
xx Contents
Differences Between MATLAB and C as Action Language
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
xxi
State Transition Table Operations . . . . . . . . . . . . . . . . . . . 13-16
Insert Rows and Columns . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
Move Rows and Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
Copy Rows and Transition Cells . . . . . . . . . . . . . . . . . . . . 13-17
Set Default State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
Add History Junction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
Print State Transition Tables . . . . . . . . . . . . . . . . . . . . . . 13-17
Select and Clear Table Elements . . . . . . . . . . . . . . . . . . . . 13-18
Undo and Redo Edit Operations . . . . . . . . . . . . . . . . . . . . 13-18
Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
xxii Contents
Benefits of Using Atomic Subcharts . . . . . . . . . . . . . . . . . . . 14-5
Comparison of Modeling Methods . . . . . . . . . . . . . . . . . . . . 14-5
Comparison of Simulation Methods . . . . . . . . . . . . . . . . . . . 14-6
Comparison of Editing Methods . . . . . . . . . . . . . . . . . . . . . 14-7
Comparison of Code Generation Methods . . . . . . . . . . . . . . 14-7
xxiii
Reduce the Compilation Time of a Chart . . . . . . . . . . . . . . 14-48
Goal of the Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-48
Edit a Model to Use Atomic Subcharts . . . . . . . . . . . . . . . 14-49
xxiv Contents
Modify SimState Values for Two Actuator Failures . . . . . . 15-31
Test the SimState for Two Failures . . . . . . . . . . . . . . . . . . 15-32
xxv
Operations For Vectors and Matrices in C Charts . . . . . . . 16-11
Binary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11
Unary Operations and Actions . . . . . . . . . . . . . . . . . . . . . 16-11
Assignment Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-12
xxvi Contents
Enumerated Data in Charts
18
What Is Enumerated Data? . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
xxvii
Continuous-Time Systems in Stateflow Charts
19
Continuous-Time Modeling in Stateflow . . . . . . . . . . . . . . . 19-2
What Is Continuous-Time Modeling? . . . . . . . . . . . . . . . . . . 19-2
When to Use Stateflow Charts for Continuous-Time
Modeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-3
Model Continuous-Time with Zero-Crossing Detection . . . . . 19-3
When to Disable Zero-Crossing Detection . . . . . . . . . . . . . . 19-4
xxviii Contents
How Fixed-Point Data Works in Stateflow Charts . . . . . . . 20-5
How Stateflow Software Defines Fixed-Point Data . . . . . . . 20-5
Specify Fixed-Point Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-6
Rules for Specifying Fixed-Point Word Length . . . . . . . . . . 20-7
Fixed-Point Context-Sensitive Constants . . . . . . . . . . . . . . . 20-7
Tips for Using Fixed-Point Data . . . . . . . . . . . . . . . . . . . . . 20-8
Detect Overflow for Fixed-Point Types . . . . . . . . . . . . . . . 20-10
Share Fixed-Point Data with Simulink Models . . . . . . . . . 20-10
xxix
Complex Data Operations for Charts That Support C
Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-7
Binary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-7
Unary Operations and Actions . . . . . . . . . . . . . . . . . . . . . . 21-7
Assignment Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8
xxx Contents
Define a Sampled Stateflow Block . . . . . . . . . . . . . . . . . . . 22-15
Define an Inherited Stateflow Block . . . . . . . . . . . . . . . . . 22-15
Define a Continuous Stateflow Block . . . . . . . . . . . . . . . . . 22-16
Define Function-Call Output Events . . . . . . . . . . . . . . . . . 22-16
Define Edge-Triggered Output Events . . . . . . . . . . . . . . . . 22-17
xxxi
Limitations for Active State Data . . . . . . . . . . . . . . . . . . . . 22-36
xxxii Contents
Integrate Custom Structures in Stateflow Charts . . . . . . . 23-22
xxxiii
Design for Isolation and Recovery in a Chart . . . . . . . . . . 24-32
Mode Logic for the Elevator Actuators . . . . . . . . . . . . . . . 24-32
States for Failure and Isolation . . . . . . . . . . . . . . . . . . . . . 24-33
Transitions for Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . 24-34
xxxiv Contents
How Stateflow Generates Content for Truth Tables . . . . . 25-69
Types of Generated Content . . . . . . . . . . . . . . . . . . . . . . . 25-69
View Generated Content . . . . . . . . . . . . . . . . . . . . . . . . . . 25-69
How Stateflow Software Generates Graphical Functions for
Truth Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-69
How Stateflow Software Generates MATLAB Code for Truth
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-73
xxxv
Debug a MATLAB Function in a Chart . . . . . . . . . . . . . . . . 26-20
Check MATLAB Functions for Syntax Errors . . . . . . . . . . 26-20
Run-Time Debugging for MATLAB Functions in Charts . . 26-21
Check for Data Range Violations . . . . . . . . . . . . . . . . . . . . 26-23
xxxvi Contents
Task 3: Configure the Function Inputs . . . . . . . . . . . . . . . 27-16
Build Targets
28
Code Generation for Stateflow Blocks . . . . . . . . . . . . . . . . . 28-2
Code Generation for Rapid Prototyping and Production Code
Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-2
xxxvii
Start Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-13
xxxviii Contents
Call Extrinsic Functions in a Stateflow Chart . . . . . . . . . . 28-38
xxxix
Guidelines for Avoiding Unwanted Recursion in a Chart . 29-33
xl Contents
Override Logging Properties in Atomic Subcharts . . . . . . . 29-62
xli
Use the Search Button and View Area . . . . . . . . . . . . . . . 30-20
Specify the Replacement Text . . . . . . . . . . . . . . . . . . . . . . 30-23
Use Replace Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-24
Search and Replace Messages . . . . . . . . . . . . . . . . . . . . . . 30-24
Semantic Examples
B
Categories of Semantic Examples . . . . . . . . . . . . . . . . . . . . . . B-2
xlii Contents
Default Transition to a Junction . . . . . . . . . . . . . . . . . . . . . B-18
Default Transition and a History Junction . . . . . . . . . . . . . B-19
Labeled Default Transitions . . . . . . . . . . . . . . . . . . . . . . . . B-20
Glossary
xliii
1
For example, you can use a state machine to represent the automatic transmission of a
car. The transmission has these operating states: park, reverse, neutral, drive, and low.
As the driver shifts from one position to another, the system makes a transition from one
state to another, for example, from park to reverse.
1-2
Finite State Machine Concepts
transitions form the basic building blocks of a sequential logic system. Another way to
represent sequential logic is a state transition table, which allows you to enter the state
logic in tabular form. You can also represent combinatorial logic in a chart with flow
charts and truth tables.
You can include Stateflow charts as blocks in a Simulink model. The collection of these
blocks in a Simulink model is the Stateflow machine.
A Stateflow chart enables the representation of hierarchy, parallelism, and history. You
can organize complex systems by defining a parent and offspring object structure [1].
For example, you can organize states within other higher-level states. A system with
parallelism can have two or more orthogonal states active at the same time. You can also
specify the destination state of a transition based on historical information.
Notation
Notation defines a set of objects and the rules that govern the relationships between
those objects. Stateflow chart notation provides a way to communicate the design
information in a Stateflow chart.
Semantics
Semantics describe how to interpret chart notation. A typical Stateflow chart contains
actions associated with transitions and states. The semantics describe the sequence of
these actions during chart execution.
1-3
1 Stateflow Chart Concepts
A Simulink model can consist of combinations of Simulink blocks, toolbox blocks, and
Stateflow blocks (charts). A chart consists of graphical objects (states, boxes, functions,
notes, transitions, connective junctions, and history junctions) and nongraphical objects
(events, messages, and data).
There is a one-to-one correspondence between the Simulink model and the Stateflow
machine. Each Stateflow block in the Simulink model appears as a single Stateflow
chart. Each Stateflow machine has its own object hierarchy. The Stateflow machine is
the highest level in the Stateflow hierarchy. The object hierarchy beneath the Stateflow
machine consists of combinations of graphical and nongraphical objects. See Stateflow
Hierarchy of Objects on page 1-8.
Stateflow charts are event-driven. Events can be local to the Stateflow block or can
propagate to and from the Simulink model. Data can be local to the Stateflow block or
can pass to and from the Simulink model and external code sources.
Defining the interface for a Stateflow block can involve some or all these tasks:
1-4
Stateflow Charts and Simulink Models
In the following example, the Simulink model consists of a Sine Wave block, a Scope
block, and a single Stateflow block, titled On_off.
1-5
1 Stateflow Chart Concepts
1-6
Stateflow Chart Objects
To learn how these objects interact, see How Chart Constructs Interact During
Execution on page 3-8.
1-7
1 Stateflow Chart Concepts
The highest object in Stateflow hierarchy is the Stateflow machine. This object contains
all other Stateflow objects in a Simulink model. The Stateflow machine contains all the
charts in a model. In addition, the Stateflow machine for a model can contain its own
data.
1-8
Stateflow Hierarchy of Objects
Similarly, charts can contain state, box, function, data, event, message, transition,
junction, and note objects. Continuing with the Stateflow hierarchy, states can contain
all these objects as well, including other states. You can represent state hierarchy with
superstates and substates.
A transition out of a superstate implies transitions out of any of its active substates.
Transitions can cross superstate boundaries to specify a substate destination. If a
substate becomes active, its parent superstate also becomes active.
1-9
1 Stateflow Chart Concepts
Bibliography
[1] Hatley, D. J. and I. A. Pirbhai. Strategies for Real-Time System Specification. New
York, NY: Dorset House Publishing, 1988.
1-10
2
In this section...
Graphical Objects on page 2-2
Nongraphical Objects on page 2-3
Graphical Objects
The following table lists each type of graphical object you can draw in a chart and the
toolbar icon to use for drawing the object.
Default transition
Connective junction
Graphical function
MATLAB function
Box
Simulink function
2-2
Overview of Stateflow Objects
Nongraphical Objects
You can define data, event, and message objects that do not appear graphically in the
Stateflow Editor. However, you can see them in the Symbols window and the Model
Explorer. See Use the Model Explorer with Stateflow Objects on page 30-10.
Data Objects
A Stateflow chart stores and retrieves data that it uses to control its execution. Stateflow
data resides in its own workspace, but you can also access data that resides externally in
the Simulink model or application that embeds the Stateflow machine. You must define
any internal or external data that you use in a Stateflow chart.
Event Objects
An event is a Stateflow object that can trigger a whole Stateflow chart or individual
actions in a chart. Because Stateflow charts execute by reacting to events, you specify
and program events into your charts to control their execution. You can broadcast events
to every object in the scope of the object sending the event, or you can send an event to a
specific object. You can define explicit events that you specify directly, or you can define
implicit events to take place when certain actions are performed, such as entering a
state.
Message Objects
Stateflow message objects are queued objects that can carry data. You can send a
message from one Stateflow chart to another to communicate between charts. You can
also send local messages within a chart. You define the type of message data. You can
view the lifeline of a message in the Message Viewer block. For more information, see
How Messages Work in Stateflow Charts on page 10-2.
2-3
2 Stateflow Chart Notation
hasChangedTo
Complex data complex Define Complex Data Using
imag Operators on page 21-9
real
2-4
Rules for Naming Stateflow Objects
int8
int16
int32
single
uint8
uint16
uint32
Data type operations cast Type Cast Operations on page
fixdt 11-24
type
Explicit events send Broadcast Events to
Synchronize States on page
11-52
Implicit events change Control Chart Execution
chg Using Implicit Events on page
9-33
tick
wakeup
Messages send Stateflow Message Syntax in
forward Charts on page 10-11
discard
isvalid
length
receive
Literal symbols inf Supported Symbols in Actions
t (C charts only) on page 11-27
2-5
2 Stateflow Chart Notation
during
en
entry
ex
exit
on
State activity in Check State Activity on page
11-86
Temporal logic after Control Chart Execution
at Using Temporal Logic on page
11-56
before
every
sec
msec
usec
temporalCount
elapsed
t
duration
2-6
States
States
In this section...
What Is a State? on page 2-7
State Hierarchy on page 2-7
State Decomposition on page 2-9
State Labels on page 2-10
What Is a State?
A state describes an operating mode of a reactive system. In a Stateflow chart, states are
used for sequential design to create state transition diagrams.
States can be active or inactive. The activity or inactivity of a state can change depending
on events and conditions. The occurrence of an event drives the execution of the state
transition diagram by making states become active or inactive. At any point during
execution, active and inactive states exist.
State Hierarchy
To manage multilevel state complexity, use hierarchy in your Stateflow chart. With
hierarchy, you can represent multiple levels of subcomponents in a system.
In the following example, three levels of hierarchy appear in the chart. Drawing one state
within the boundaries of another state indicates that the inner state is a substate (or
child) of the outer state (or superstate). The outer state is the parent of the inner state.
2-7
2 Stateflow Chart Notation
In this example, the chart is the parent of the state Car_done. The state Car_done is
the parent state of the Car_made and Car_shipped states. The state Car_made is also
the parent of the Parts_assembled and Painted states. You can also say that the
states Parts_assembled and Painted are children of the Car_made state.
To represent the Stateflow hierarchy textually, use a slash character (/) to represent
the chart and use a period (.) to separate each level in the hierarchy of states. The
following list is a textual representation of the hierarchy of objects in the preceding
example:
/Car_done
/Car_done.Car_made
/Car_done.Car_shipped
/Car_done.Car_made.Parts_assembled
/Car_done.Car_made.Painted
States can contain all other Stateflow objects. Stateflow chart notation supports the
representation of graphical object hierarchy in Stateflow charts with containment. A
state is a superstate if it contains other states. A state is a substate if it is contained by
another state. A state that is neither a superstate nor a substate of another state is a
state whose parent is the Stateflow chart itself.
2-8
States
States can also contain nongraphical data, event, and message objects. The hierarchy of
this containment appears in the Model Explorer. You define data, event, and message
containment by specifying the parent object.
State Decomposition
Every state (or chart) has a decomposition that dictates what type of substates the state
(or chart) can contain. All substates of a superstate must be of the same type as the
superstate decomposition. State decomposition can be exclusive (OR) or parallel (AND).
Substates with solid borders indicate exclusive (OR) state decomposition. Use this
decomposition to describe operating modes that are mutually exclusive. When a state has
exclusive (OR) decomposition, only one substate can be active at a time.
In the following example, either state A or state B can be active. If state A is active, either
state A1 or state A2 can be active at a given time.
Substates with dashed borders indicate parallel (AND) decomposition. Use this
decomposition to describe concurrent operating modes. When a state has parallel (AND)
decomposition, all substates are active at the same time.
In the following example, when state A is active, A1 and A2 are both active at the same
time.
2-9
2 Stateflow Chart Notation
In the following example, when state A becomes active, both states B and C become active
at the same time. When state C becomes active, either state C1 or state C2 can be active.
State Labels
The label for a state appears on the top left corner of the state rectangle with the
following general format:
name/
entry:entry actions
during:during actions
2-10
States
exit:exit actions
on event_name:on event_name actions
on message_name:on message_name actions
bind:events
Each action in the state label appears in the subtopics that follow. For more information
on state actions, see:
Process for Entering, Executing, and Exiting States on page 3-74 Describes
how and when entry, during, exit, and on event_name actions occur.
State Action Types on page 11-2 Gives more detailed descriptions of each
type of state action.
State Name
A state label starts with the name of the state followed by an optional / character. In
the preceding example, the state names are On and Off. Valid state names consist
of alphanumeric characters and can include the underscore (_) character. For more
information, see Rules for Naming Stateflow Objects on page 2-4.
2-11
2 Stateflow Chart Notation
Hierarchy provides some flexibility in naming states. The name that you enter on the
state label must be unique when preceded by ancestor states. The name in the Stateflow
hierarchy is the text you enter as the label on the state, preceded by the names of parent
states separated by periods. Each state can have the same name appear in the label, as
long as their full names within the hierarchy are unique. Otherwise, the parser indicates
an error.
Each of these states has a unique name because of its location in the chart. The full
names for the states in FAN1 and FAN2 are:
PowerOn.FAN1.On
2-12
States
PowerOn.FAN1.Off
PowerOn.FAN2.On
PowerOn.FAN2.Off
State Actions
After the name, you enter optional action statements for the state with a keyword label
that identifies the type of action. You can specify none, some, or all of them. The colon
after each keyword is required. The slash following the state name is optional as long as
it is followed by a carriage return.
For each type of action, you can enter more than one action by separating each action
with a carriage return, semicolon, or a comma. You can specify actions for more than one
event or message by adding additional on event_name or on message_name lines.
If you enter the name and slash followed directly by actions, the actions are interpreted
as entry action(s). This shorthand is useful if you are specifying only entry actions.
Entry Action
Preceded by the prefix entry or en for short. In the preceding example, state On
has entry action on_count=0. This means that the value of on_count is reset to 0
whenever state On becomes active (entered).
During Action
Preceded by the prefix during or du for short. In the preceding label example, state On
has two during actions, light_on() and on_count++. These actions are executed
whenever state On is already active and any event occurs.
Exit Action
Preceded by the prefix exit or ex for short. In the preceding label example, state Off
has the exit action light_off(). If the state Off is active, but becomes inactive
(exited), this action is executed.
On Action
2-13
2 Stateflow Chart Notation
Bind Action
Preceded by the prefix bind. Events bound to a state can only be broadcast by that state
or its children.
2-14
State Hierarchy
State Hierarchy
In this section...
State Hierarchy Example on page 2-15
Objects That a State Can Contain on page 2-16
To manage multilevel state complexity, use hierarchy in your Stateflow chart. With
hierarchy, you can represent multiple levels of subcomponents in a system.
In this example, the chart is the parent of the state Car_done. The state Car_done is
the parent state of the Car_made and Car_shipped states. The state Car_made is also
the parent of the Parts_assembled and Painted states. You can also say that the
states Parts_assembled and Painted are children of the Car_made state.
To represent the Stateflow hierarchy textually, use a slash character (/) to represent
the chart and use a period (.) to separate each level in the hierarchy of states. The
2-15
2 Stateflow Chart Notation
/Car_done
/Car_done.Car_made
/Car_done.Car_shipped
/Car_done.Car_made.Parts_assembled
/Car_done.Car_made.Painted
States can also contain nongraphical data, event, and message objects. The hierarchy of
this containment appears in the Model Explorer. You define data, event, and message
containment by specifying the parent object.
2-16
State Decomposition
State Decomposition
In this section...
Exclusive (OR) State Decomposition on page 2-17
Parallel (AND) State Decomposition on page 2-17
Every state (or chart) has a decomposition that dictates what type of substates the state
(or chart) can contain. All substates of a superstate must be of the same type as the
superstate decomposition. State decomposition can be exclusive (OR) or parallel (AND).
In the following example, either state A or state B can be active. If state A is active, either
state A1 or state A2 can be active at a given time.
2-17
2 Stateflow Chart Notation
In the following example, when state A is active, A1 and A2 are both active at the same
time.
In the following example, when state A becomes active, both states B and C become active
at the same time. When state C becomes active, either state C1 or state C2 can be active.
2-18
Transitions
Transitions
In this section...
What Is a Transition? on page 2-19
Transition Hierarchy on page 2-20
Transition Label Notation on page 2-21
Valid Transitions on page 2-23
What Is a Transition?
A transition is a line with an arrowhead that links one graphical object to another. In
most cases, a transition represents the passage of the system from one mode (state)
object to another. A transition typically connects a source and a destination object.
The source object is where the transition begins and the destination object is where
the transition ends. The following chart shows a transition from a source state, B, to a
destination state, A.
Junctions divide a transition into transition segments. In this case, a full transition
consists of the segments taken from the origin to the destination state. Each segment is
evaluated in the process of determining the validity of a full transition.
The following example has two segmented transitions: one from state On to state Off,
and the other from state On to itself:
2-19
2 Stateflow Chart Notation
A default transition is a special type of transition that has no source object. See Default
Transitions on page 2-35 for details.
Transition Hierarchy
Transitions cannot contain other objects the way that states can. However, transitions
are contained by states. A transition's hierarchy is described in terms of the transition's
parent, source, and destination. The parent is the lowest level that contains the source
and destination of the transition. Consider the parents for the transitions in the following
example:
2-20
Transitions
The following table resolves the parentage of each transition in the preceding example.
The / character represents the chart. Each level in the hierarchy of states is separated
by the period (.) character.
event_or_message[condition]{condition_action}/transition_action
2-21
2 Stateflow Chart Notation
Event Trigger
Specifies an event that causes the transition to be taken, provided the condition, if
specified, is true. Specifying an event is optional. The absence of an event or message
indicates that the transition is taken upon the occurrence of any event. Specify multiple
events using the OR logical operator (|).
In the preceding example, the broadcast of event E triggers the transition from On to Off
as long as the condition [off_count==0] is true.
Condition
Specifies a Boolean expression that, when true, validates a transition to be taken for the
specified event or message trigger. Enclose the condition in square brackets ([]). See
Conditions on page 11-10 for information on the condition notation.
In the preceding example, the condition [off_count==0] must evaluate as true for the
condition action to be executed and for the transition from the source to the destination
to be valid.
Condition Action
Follows the condition for a transition and is enclosed in curly braces ({}). It is executed
as soon as the condition is evaluated as true and before the transition destination has
been determined to be valid. If no condition is specified, an implied condition evaluates to
true and the condition action is executed.
In the preceding example, if the condition [off_count==0] is true, the condition action
off_count = off_count + 1; is immediately executed.
2-22
Transitions
Transition Action
Executes after the transition destination has been determined to be valid provided
the condition, if specified, is true. If the transition consists of multiple segments, the
transition action is only executed when the entire transition path to the final destination
is determined to be valid. Precede the transition action with a /.
In the preceding example, if the condition [off_count==0] is true, and the destination
state Off is valid, the transition action Light_off is executed.
Valid Transitions
In most cases, a transition is valid when the source state of the transition is active and
the transition label is valid. Default transitions are different because there is no source
state. Validity of a default transition to a substate is evaluated when there is a transition
to its superstate, assuming the superstate is active. This labeling criterion applies to
both default transitions and general case transitions. The following table lists possible
combinations of valid transition labels.
2-23
2 Stateflow Chart Notation
Transition Connections
In this section...
Transitions to and from Exclusive (OR) States on page 2-24
Transitions to and from Junctions on page 2-24
Transitions to and from Exclusive (OR) Superstates on page 2-25
Transitions to and from Substates on page 2-26
See Transition to and from Exclusive (OR) States on page B-4 for more
information on the semantics of this notation.
2-24
Transition Connections
The chart uses temporal logic to determine when the input u equals 1.
For more information about temporal logic, see Control Chart Execution Using
Temporal Logic on page 11-56. For more information on the semantics of this
notation, see Transition from a Common Source to Multiple Destinations on page
B-36.
2-25
2 Stateflow Chart Notation
The chart has two states at the highest level in the hierarchy, Power_off and
Power_on. By default, Power_off is active. The event Switch toggles the system
between the Power_off and Power_on states. Power_on has three substates: First,
Second, and Third. By default, when Power_on becomes active, First also becomes
active. When Shift equals 1, the system transitions from First to Second, Second to
Third, Third to First, for each occurrence of the event Switch, and then the pattern
repeats.
For more information on the semantics of this notation, see Control Chart Execution
Using Default Transitions on page B-17.
2-26
Transition Connections
For details on how this chart works, see Key Behaviors of Debouncer Chart on page
24-3. For information on the semantics of this notation, see Transition from a
Substate to a Substate with Events on page B-8.
2-27
2 Stateflow Chart Notation
Self-Loop Transitions
A transition that originates from and terminates on the same state is a self-loop
transition. The following chart contains four self-loop transitions:
See these sections for more information about the semantics of this notation:
2-28
Self-Loop Transitions
2-29
2 Stateflow Chart Notation
Inner Transitions
An inner transition is a transition that does not exit the source state. Inner transitions
are powerful when defined for superstates with exclusive (OR) decomposition. Use
of inner transitions can greatly simplify a Stateflow chart, as shown by the following
examples:
2-30
Inner Transitions
Any event occurs and awakens the Stateflow chart. The default transition to the
connective junction is valid. The destination of the transition is determined by [c1 > 0]
2-31
2 Stateflow Chart Notation
and [c2 > 0]. If [c1 > 0] is true, the transition to A1 is true. If [c2 > 0] is true, the
transition to A2 is valid. If neither [c1 > 0] nor [c2 > 0] is true, the transition to A3
is valid. The transitions among A1, A2, and A3 are determined by E, [c1 > 0], and [c2
> 0].
An event occurs and awakens the chart. The default transition to the connective junction
is valid. The destination of the transitions is determined by [c1 > 0] and [c2 > 0].
You can simplify the chart by using an inner transition in place of the transitions among
all the states in the original example. If state A is already active, the inner transition is
used to reevaluate which of the substates of state A is to be active. When event E occurs,
the inner transition is potentially valid. If [c1 > 0] is true, the transition to A1 is valid.
If [c2 > 0] is true, the transition to A2 is valid. If neither [c1 > 0] nor [c2 > 0] is
true, the transition to A3 is valid. This chart design is simpler than the previous one.
Note: When you use an inner transition to a connective junction, an active substate can
exit and reenter when the transition condition for that substate is valid. For example, if
substate A1 is active and [c1 > 0] is true, the transition to A1 is valid. In this case:
2-32
Inner Transitions
See Process the First Event with an Inner Transition to a Connective Junction on page
B-26 for more information on the semantics of this notation.
State Power_on.High is initially active. When event Reset occurs, the inner transition
to the history junction is valid. Because the inner transition is valid, the currently active
state, Power_on.High, is exited. When the inner transition to the history junction
is processed, the last active state, Power_on.High, becomes active (is reentered). If
Power_on.Low was active under the same circumstances, Power_on.Low would be
exited and reentered as a result. The inner transition in this example is equivalent to
drawing an outer self-loop transition on both Power_on.Low and Power_on.High.
2-33
2 Stateflow Chart Notation
See Use of History Junctions Example on page 2-46 for another example using a
history junction.
See Inner Transition to a History Junction on page B-28 for more information on
the semantics of this notation.
2-34
Default Transitions
Default Transitions
In this section...
What Is a Default Transition? on page 2-35
Drawing Default Transitions on page 2-35
Label Default Transitions on page 2-35
Default Transition Examples on page 2-36
2-35
2 Stateflow Chart Notation
Tip: When labeling default transitions, ensure that there is at least one valid default
transition. Otherwise, a chart can transition into an inconsistent state.
2-36
Default Transitions
Without the default transition to state PowerOff, when the Stateflow chart wakes up,
none of the states becomes active. A state inconsistency error is reported at run time.
See Control Chart Execution Using Default Transitions on page B-17 for
information on the semantics of this notation.
2-37
2 Stateflow Chart Notation
The default transition to the connective junction defines that upon entering the chart, the
destination depends on the condition of each transition segment.
See Default Transition to a Junction on page B-18 for information on the semantics
of this notation.
2-38
Default Transitions
When the chart wakes up, the data p and v initialize to 10 and 15, respectively.
See Labeled Default Transitions on page B-20 for more information on the
semantics of this notation.
2-39
2 Stateflow Chart Notation
Connective Junctions
In this section...
What Is a Connective Junction? on page 2-40
Flow Chart Notation with Connective Junctions on page 2-40
See Use Connective Junctions to Represent Multiple Paths on page B-30 for a
summary of the semantics of connective junctions.
2-40
Connective Junctions
Flow chart notation, states, and state-to-state transitions coexist in the same Stateflow
chart. The key to representing flow chart notation is in the labeling of transitions, as
shown in the following examples.
2-41
2 Stateflow Chart Notation
For more information about this chart, see Phases of Chart Execution on page 3-13.
For more information on the semantics of this notation, see If-Then-Else Decision
Construct on page B-31.
The chart uses temporal logic to determine when the input u equals 1.
For more information about temporal logic, see Control Chart Execution Using
Temporal Logic on page 11-56. For more information on the semantics of this
notation, see If-Then-Else Decision Construct on page B-31.
This example shows a combination of flow chart notation and state transition notation.
Self-loop transitions to connective junctions can represent for loop constructs. The
2-42
Connective Junctions
chart uses implicit ordering of outgoing transitions (see Implicit Ordering of Outgoing
Transitions on page 3-64).
See For-Loop Construct on page B-33 for information on the semantics of this
notation.
This example shows the use of flow chart notation. The chart uses implicit ordering of
outgoing transitions (see Implicit Ordering of Outgoing Transitions on page 3-64).
2-43
2 Stateflow Chart Notation
See Flow Chart Notation on page B-35 for information on the semantics of this
notation.
This example shows transition segments from a common source to multiple conditional
destinations using a connective junction. The chart uses implicit ordering of outgoing
transitions (see Implicit Ordering of Outgoing Transitions on page 3-64).
2-44
Connective Junctions
See Transition from a Common Source to Multiple Destinations on page B-36 for
information on the semantics of this notation.
This example shows transition segments from multiple sources to a single destination
based on the same event using a connective junction.
2-45
2 Stateflow Chart Notation
History Junctions
In this section...
What Is a History Junction? on page 2-46
History Junctions and Inner Transitions on page 2-47
Superstate Power_on has a history junction and contains two substates. If state
Power_off is active and event switch_on occurs, the system can enter Power_on.Low
or Power_on.High. The first time superstate Power_on is entered, substate
Power_on.Low is entered because it has a default transition. At some point afterward,
if state Power_on.High is active and event switch_off occurs, superstate Power_on
2-46
History Junctions
is exited and state Power_off becomes active. Then event switch_on occurs. Because
Power_on.High was the last active substate, it becomes active again. After the first
time Power_on becomes active, the history junction determines whether to enter
Power_on.Low or Power_on.High.
See Default Transition and a History Junction on page B-19 for more information
on the semantics of this notation.
See Using an Inner Transition to a History Junction on page 2-33 for an example of this
notation.
See Inner Transition to a History Junction on page B-28 for more information on
the semantics of this notation.
2-47
2 Stateflow Chart Notation
Boxes
In this section...
What Is a Box? on page 2-48
Example of Using a Box on page 2-48
What Is a Box?
A box is a graphical object that organizes other objects in your chart, such as functions
and states.
For rules of using boxes and other examples, see Group Chart Objects Using Boxes on
page 7-41.
2-48
When to Use Reusable Functions in Charts
Flow chart Encapsulate flow charts containing if-then-else, switch-case, for, while,
or do-while patterns.
MATLAB Write matrix-oriented algorithms; call MATLAB functions for data
analysis and visualization.
Simulink Call Simulink function-call subsystems directly to streamline design and
improve readability.
Truth table Represent combinational logic for decision-making applications such as
fault detection and mode switching.
Use the function format that is most natural for the type of calculation required in the
state action or transition condition.
If the four standard types of Stateflow functions do not work, you can write your own
C or C++ code for integration with your chart. For more information about custom code
integration, see Share Data Using Custom C Code on page 28-25.
2-49
3
Graphical Constructs
Graphical constructs consist of objects that appear graphically in a chart. You use the
object palette in the Stateflow Editor to build graphical constructs (see Stateflow Editor
Operations on page 4-26).
3-2
What Do Semantics Mean for Stateflow Charts?
Nongraphical Constructs
Nongraphical constructs appear textually in a chart and often refer to data, events, and
messages. See Add Stateflow Data on page 8-2 ,Define Events on page 9-5,
and Define Messages in a Stateflow Chart on page 10-25 for details. Examples of
nongraphical constructs include:
3-3
3 Stateflow Chart Semantics
3-4
What Do Semantics Mean for Stateflow Charts?
3-5
3 Stateflow Chart Semantics
For details on how these graphical and nongraphical constructs interact during chart
execution, see How Chart Constructs Interact During Execution on page 3-8.
3-6
What Do Semantics Mean for Stateflow Charts?
Topic Reference
How do events affect chart execution? How Events Drive Chart Execution on page
3-43
How does a chart switch between being active Types of Chart Execution on page 3-46
and inactive?
In what order do flow charts execute? Process for Grouping and Executing
Transitions on page 3-57
In what order do outgoing transitions from a Evaluation Order for Outgoing Transitions on
single source execute? page 3-60
What happens when you enter, execute, or exit a Process for Entering, Executing, and Exiting
state? States on page 3-74
How do parallel (AND) states work? Execution Order for Parallel States on page
3-78
How does early return logic affect chart Early Return Logic for Event Broadcasts on
execution? page 3-85
3-7
3 Stateflow Chart Semantics
In this section...
Overview of the Example Model on page 3-8
Model of the Check-In Process for a Hotel on page 3-8
How the Chart Interacts with Simulink Blocks on page 3-12
Phases of Chart Execution on page 3-13
For details of the chart semantics, see Phases of Chart Execution on page 3-13.
The model consists of four Manual Switch blocks, one Mux block, one Multiport Switch
block, a Hotel chart, and a Display block.
3-8
How Chart Constructs Interact During Execution
Checking in to a hotel
Calling room service
Triggering a fire alarm
Sending an all-clear signal after a
fire alarm
3-9
3 Stateflow Chart Semantics
The Hotel chart contains graphical constructs, such as states and history junctions, and
nongraphical constructs, such as conditions and condition actions.
3-10
How Chart Constructs Interact During Execution
For a mapping of constructs to their locations in the chart, see Common Graphical and
Nongraphical Constructs on page 3-3.
3-11
3 Stateflow Chart Semantics
When simulation starts, the chart wakes up and executes its default transitions because
the Execute (enter) Chart At Initialization option is on (see Execution of a Chart at
Initialization on page 3-55). Then the chart goes to sleep.
Note: If this option is off, the chart does not wake up until you toggle one of the Manual
Switch blocks. You can verify the setting for this option in the Chart properties dialog
box. Right-click inside the top level of the chart and select Properties from the context
menu.
The chart wakes up again only when an edge-triggered input event occurs: check_in,
room_service, fire_alarm, or all_clear. When you toggle a Manual Switch block
for an input event during simulation, the chart detects a rising or falling edge and wakes
up. While the chart is awake:
The Multiport Switch block provides a value for the chart input data room_type.
The Display block shows any change in value for the chart output data fee.
Chart Inactivity
After completing all possible phases of execution, the chart goes back to sleep.
3-12
How Chart Constructs Interact During Execution
This section describes what happens in the Front_desk state just after the chart wakes
up.
3-13
3 Stateflow Chart Semantics
3-14
How Chart Constructs Interact During Execution
3-15
3 Stateflow Chart Semantics
This section describes what happens after exiting the Front_desk state: the evaluation
of a group of outgoing transitions from a single junction.
3-16
How Chart Constructs Interact During Execution
3-17
3 Stateflow Chart Semantics
Because the Multiport Switch block outputs only 1, 2, or 3, room_type cannot have any
other values. However, if room_type has a value other than 1, 2, or 3, the chart stays in
the Front_desk state. This behavior applies because no transition path out of that state
is valid.
3-18
How Chart Constructs Interact During Execution
This section describes what happens after you enter the Checked_in state, regardless of
which substate becomes active.
3-19
3 Stateflow Chart Semantics
3-20
How Chart Constructs Interact During Execution
This part of the chart describes how you can perform function calls while a state is active.
3-21
3 Stateflow Chart Semantics
3-22
How Chart Constructs Interact During Execution
if (room_type == 1)
y = 1500 + (x*50);
else
if (room_type == 2)
y = 1000 + (x*25);
else
y = 500 + (x*5);
end
end
Modeling Guidelines for Function Calls. The following guidelines apply to function
calls.
This part of the chart shows how a state with exclusive (OR) decomposition executes.
3-23
3 Stateflow Chart Semantics
3-24
How Chart Constructs Interact During Execution
3-25
3 Stateflow Chart Semantics
This part of the chart shows how a state with parallel (AND) decomposition executes.
3-26
How Chart Constructs Interact During Execution
3-27
3 Stateflow Chart Semantics
This part of the chart describes how events can guard transitions between exclusive (OR)
states.
3-28
How Chart Constructs Interact During Execution
3-29
3 Stateflow Chart Semantics
a Dining_area
b Executive_suite
c Checked_in
d Check_in
2 Waiting_area becomes active.
2 If an all-clear signal When the chart receives an event broadcast for all_clear, a
occurs, you can leave the transition from Waiting_area to the previously active substate
waiting area and return of Check_in occurs.
to your previous location
inside the hotel. The history junction at each level of hierarchy in Check_in
enables the chart to remember which substate was previously
active before the transition to Waiting_area occurred.
a Check_in
b Checked_in (The default transition does not apply.)
c Executive_suite
d Dining_area (The default transition does not apply.)
3-30
How Chart Constructs Interact During Execution
3-31
3 Stateflow Chart Semantics
When you use multiple input events to trigger a chart, verify that all input signals use
the same data type. Otherwise, simulation stops and an error message appears. For more
information, see Data Types Allowed for Input Events on page 9-11.
Use a default transition to mark the first state to become active among exclusive (OR) states
Condition actions execute as soon as the condition evaluates to true. Transition actions
do not execute until after the transition path is complete, to a terminating junction or a
state.
Use explicit ordering to control the testing order of a group of outgoing transitions
You can specify explicit or implicit ordering of transitions. By default, a chart uses
explicit ordering. If you switch to implicit ordering, the transition testing order can
change when graphical objects move.
Use a superstate to enclose substates that share the same state actions
When you have multiple exclusive (OR) states that perform the same state actions, group
these states in a superstate and define state actions at that level.
This guideline enables reuse of state actions that apply to multiple substates. You write
the state actions only once, instead of writing them separately in each substate.
3-32
Modeling Guidelines for Stateflow Charts
Note: You cannot use boxes for this purpose because boxes do not support state actions.
If reentry to a state with exclusive (OR) decomposition depends on the previously active
substate, use a history junction. This type of junction records the active substate when
the chart exits the state. If you do not record the previously active substate, the default
transition occurs and the wrong substate can become active upon state reentry.
This guideline prevents parsing errors. Since all parallel states at a level of hierarchy are
active at the same time, history junctions have no meaning.
Use explicit ordering to control the execution order of parallel (AND) states
You can specify explicit or implicit ordering of parallel states. By default, a chart uses
explicit ordering. If you switch to implicit ordering, the execution order can change when
parallel states move.
3-33
3 Stateflow Chart Semantics
In this section...
Object contains a syntax error on page 3-35
Dangling transitions on page 3-35
Unreachable state on page 3-36
Transition shadowing on page 3-36
Invalid default transition path on page 3-37
Default transition is missing on page 3-38
Unexpected backtracking on page 3-38
Transition loops outside natural parent on page 3-39
Transition action precedes a condition action along this path on page 3-40
Invalid transitions crossing into graphical function on page 3-41
Invalid transitions crossing out of graphical function on page 3-41
The Stateflow editor displays potential errors and warnings by highlighting objects in
red or orange. By fixing these issues when you design your charts, you avoid potential
compile or run-time warnings and errors. To see details and possible fixes, hover your
cursor over the object and click the badge.
To turn off the edit-time checking, clear Display > Error & Warnings. When you
change the diagnostic level of a corresponding configuration parameter, the edit-time
diagnostic level also changes. For example, if you set the Unreachable execution path
configuration parameter on the Diagnostics > Stateflow pane in the Configuration
Parameters dialog box to none, then Stateflow does not highlight transition shadowing
in the editor. Not all edit-time checks have corresponding configuration parameters.
3-34
Modeling Rules That Stateflow Detects During Edit Time
Note: Subcharts with syntax errors appear red in the parent chart with a badge
indicating a syntax issue. In the subchart editor, the object is highlighted in red, however
there is no badge indicating the issue.
Dangling transitions
A dangling transition is not connected to a destination object. Transitions must have a
valid source state or junction and a valid destination state or junction. See Transitions
on page 2-19.
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Unreachable execution path parameter in the Model Configuration Parameters dialog
box.
3-35
3 Stateflow Chart Semantics
Unreachable state
If there is not a valid execution path leading to a state, it is unreachable. Make this state
a reachable destination by connecting the state with a transition from a reachable state
or junction.
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Unreachable execution path parameter in the Model Configuration Parameters dialog
box.
Transition shadowing
Transition shadowing occurs when a chart contains an unconditional transition
originating from a source that prevents other transitions from the same source from
executing.
To avoid transition shadowing, create no more than one unconditional transition for each
group of outgoing transitions from a state or junction. Explicitly specify an unconditional
3-36
Modeling Rules That Stateflow Detects During Edit Time
transition as a lower evaluation order than any transitions with conditions. See
Evaluation Order for Outgoing Transitions on page 3-60.
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Unreachable execution path parameter in the Model Configuration Parameters dialog
box.
When possible, click Fix for Stateflow to switch the execution orders for the transitions.
You can undo the applied fix from the Edit menu.
3-37
3 Stateflow Chart Semantics
When you click Fix, Stateflow adds a default transition to the upper-left state or
junction.
Unexpected backtracking
Unintended backtracking of control flow can occur at a junction under these conditions:
The junction does not have an unconditional transition path to a state or terminating
junction.
Multiple transition paths lead to that junction.
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Unexpected backtracking parameter in the Model Configuration Parameters dialog
box.
3-38
Modeling Rules That Stateflow Detects During Edit Time
When you click Fix, Stateflow adds a transition from the backtracking junction to a
terminating junction. You can undo the applied fix from the Edit menu.
To have execution move from state B to state C without exiting and reentering state A,
move the transition so that it is contained within state A.
3-39
3 Stateflow Chart Semantics
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Transition outside natural parent parameter in the Model Configuration Parameters
dialog box.
3-40
Modeling Rules That Stateflow Detects During Edit Time
Execution order:
1 Evaluate ConditionA.
2 If true, evaluate ConditionB.
3 If true, execute ConditionAction2.
4 Exit state A.
5 Execute TranstionAction1.
6 Enter state B.
To improve clarity, place the transition action after the last condition action on the path.
Control the level of diagnostic action by setting the Diagnostics > Stateflow >
Transition action specified before condition action parameter in the Model
Configuration Parameters dialog box.
More About
What Do Semantics Mean for Stateflow Charts? on page 3-2
3-41
3 Stateflow Chart Semantics
3-42
How Events Drive Chart Execution
Because a chart runs on a single thread, actions that take place based on an event
are atomic to that event. All activity caused by the event in the chart finishes before
execution returns to the activity that was taking place before receiving the event. Once
an event initiates an action, the action completes unless interrupted by an early return.
3-43
3 Stateflow Chart Semantics
States on page 11-52. For examples using event broadcasting and directed event
broadcasting, see:
Events have hierarchy (a parent) and scope. The parent and scope together define a
range of access to events. The parent of an event usually determines who can trigger
on the event (has receive rights). See the Name and Parent fields for an event in Set
Properties for an Event on page 9-7 for more information.
All events, except for the output edge trigger to a Simulink block (see the following note),
have the following execution in a chart:
1 If the receiver of the event is active, then it executes (see Execution of an Active
Chart on page 3-47 and Steps for Executing an Active State on page 3-75).
(The event receiver is the parent of the event unless a directed event broadcast
occurs using the send() function.)
2 If the receiver of the event is not active, nothing happens.
3 After broadcasting the event, the broadcaster performs early return logic based on
the type of action statement that caused the event.
To learn about early return logic, see Early Return Logic for Event Broadcasts on
page 3-85.
3-44
How Events Drive Chart Execution
3-45
3 Stateflow Chart Semantics
Stage Description
Inactive Chart has no active states
Active Chart has active states
Sleeping Chart has active states, but no events to
process
When a Simulink model first triggers a Stateflow chart, the chart is inactive and has no
active states. After the chart executes and completely processes its initial trigger event
from the Simulink model, it transfers control back to the model and goes to sleep. At the
next Simulink trigger event, the chart changes from the sleeping to active stage.
If executing the default flow paths does not cause state entry, a state inconsistency error
occurs.
3-46
Types of Chart Execution
By default, Stateflow charts execute once for each active input event. If no input events
exist, the charts execute once every time step. If you are modeling a system that must
react quickly to inputs, you can enable super step semantics, a Stateflow chart property
(see Enable Super Step Semantics on page 3-48).
When you enable super step semantics, a Stateflow chart executes multiple times for
every active input event or for every time step when the chart has no input events. The
chart takes valid transitions until either of these conditions occurs:
No more valid transitions exist, that is, the chart is in a stable active state
configuration.
The number of transitions taken exceeds a user-specified maximum number of
iterations.
In a super step, your chart responds faster to inputs but performs more computations in
each time step. Therefore, when generating code for an embedded target, make sure that
the chart can finish the computation in a single time step. To achieve this behavior, fine-
tune super step parameters by setting an upper limit on the number of transitions that
the chart takes per time step (see What Is Maximum Number of Iterations? on page
3-47).
For simulation targets, specify whether the chart goes to the next time step or generates
an error if it reaches the maximum number of transitions prematurely. However, in
generated code for embedded targets, the chart always goes to the next time step after
taking the maximum number of transitions.
In a super step, your chart always takes at least one transition. Therefore, when you
set a maximum number of iterations in each super step, the chart takes that number of
3-47
3 Stateflow Chart Semantics
transitions plus 1. For example, if you specify 10 as the maximum number of iterations,
your chart takes 11 transitions in each super step. To set maximum number of iterations
in each super step, see Enable Super Step Semantics on page 3-48.
1 Right-click inside the top level of a chart and select Properties from the context
menu.
2 In the Chart properties dialog box, select the Enable Super Step Semantics check
box.
3-48
Types of Chart Execution
The chart always takes one transition during a super step, so the value N that you
specify represents the maximum number of additional transitions (for a total of N
+1). Try to choose a number that allows the chart to reach a stable state within the
3-49
3 Stateflow Chart Semantics
time step, based on the mode logic of your chart. For more information, see What Is
Maximum Number of Iterations? on page 3-47
4 Select an action from the drop-down menu in the field Behavior after too many
iterations.
Your selection determines how the chart behaves during simulation if it exceeds the
maximum number of iterations in the super step before reaching a stable state.
Behavior Description
Proceed The chart goes back to sleep with the last active state
configuration, that is, after updating local data at the last
valid transition in the super step.
Throw Error Simulation stops and the chart generates an error,
indicating that too many iterations occurred while trying to
reach a stable state.
Note: This option is relevant only for simulation targets. For embedded targets, code
generation goes to the next time step rather than generating an error.
The following model shows how super step semantics differs from default semantics:
3-50
Types of Chart Execution
By default, the chart takes only one transition in each simulation step, incrementing y
each time.
When you enable super step semantics, the chart takes all valid transitions in each time
step, stopping at state C with y = 3.
3-51
3 Stateflow Chart Semantics
When you enable super step semantics for a chart with multiple active input events, the
chart takes all valid transitions for the first active event before it begins processing the
next active event. For example, consider the following model:
3-52
Types of Chart Execution
In this model, the Sum block produces a 2-by-1 vector signal that goes from [0,0] to [1,1]
at time t = 1. As a result, when the model wakes up the chart, events E1 and E2 are both
active:
If you enable super step semantics, the chart takes all valid transitions for event E1. The
chart takes transitions from state A to B and then from state B to C in a single super step.
The scope shows that y = 3 at the end of the super step:
3-53
3 Stateflow Chart Semantics
In a super step, this chart never transitions to state D because there is no path from state
C to state D.
If your chart contains transition cycles, taking multiple transitions in a single time step
can cause infinite loops. Consider the following example:
3-54
Types of Chart Execution
In this example, the transitions between states A and B cycle and produce an infinite
loop because the value of x remains constant at 1. One way to detect infinite loops is to
configure your chart to generate an error if it reaches a maximum number of iterations in
a super step. See Enable Super Step Semantics on page 3-48.
By default, the first time a chart wakes up, it executes the default transition paths. At
this time, the chart can access inputs, write to outputs, and broadcast events. If you want
your chart to begin executing from a known configuration, you can enable the option
to execute at initialization. When you turn on this option, the state configuration of a
chart initializes at time 0 instead of the first occurrence of an input event. The default
transition paths of the chart execute during the model initialization phase at time 0,
corresponding to the mdlInitializeConditions() (Simulink) phase for S-functions.
You select the Execute (enter) Chart At Initialization check box in the Chart
properties dialog box, as described in Specify Chart Properties on page 22-3.
Note: If an output of this chart connects to a SimEvents block, do not select this check
box. To learn more about using Stateflow charts and SimEvents blocks together in a
model, see the SimEvents documentation.
3-55
3 Stateflow Chart Semantics
Due to the transient nature of the initialization phase, do not perform certain actions in
the default transition paths of the chart and associated state entry actions which
execute at initialization. Follow these guidelines:
Do not access chart input data, because blocks connected to chart input ports might
not have initialized their outputs yet.
Do not call exported graphical functions from other charts, because those charts might
not have initialized yet.
Do not broadcast function-call output events, because the triggered subsystems might
not have initialized yet.
You can control the level of diagnostic action for invalid access to chart input data in
the Diagnostics > Stateflow pane of the Configuration Parameters dialog box. For
more information, see the documentation for the Invalid input data access in chart
initialization (Simulink) diagnostic.
3-56
Process for Grouping and Executing Transitions
Default flow charts are all default transition segments that start with the same
parent.
Inner flow charts are all transition segments that originate on a state and reside
entirely within that state.
Outer flow charts are all transition segments that originate on the respective state
but reside at least partially outside that state.
Each set of flow charts includes other transition segments connected to a qualifying
transition segment through junctions and transitions. Consider the following example:
In this example, state A has both an inner and a default transition that connect to a
junction with outgoing transitions to states A.A1 and A.A2. If state A is active, its set of
inner flow charts includes:
3-57
3 Stateflow Chart Semantics
In this case, the two outgoing transition segments from the junction are members of more
than one flow chart type.
An active state can have several possible outgoing transitions. The chart orders
these transitions before checking them for validity. See Evaluation Order for
Outgoing Transitions on page 3-60.
2 Select the next transition segment in the set of ordered transitions.
3 Test the transition segment for validity.
4 If the segment is invalid, go to step 2.
5 If the destination of the transition segment is a state, do the following:
3-58
Process for Grouping and Executing Transitions
a Backtrack the incoming transition segment that brought you to the junction.
b Continue at step 2, starting with the next transition segment after the backup
segment.
The set of flow charts completes execution when all starting transitions have been
tested.
3-59
3 Stateflow Chart Semantics
Explicit ordering
Override explicit ordering in C charts by letting Stateflow use internal rules to order
transitions (see Implicit Ordering of Outgoing Transitions on page 3-64).
Note: You can order transitions only within their type (inner, outer, or default). For more
information, see Transition Flow Chart Types on page 3-57.
Outgoing transitions are assigned priority numbers based on order of evaluation. The
lower the number, the higher the priority. The priority number appears on each outgoing
transition.
Because evaluation order is a chart property, all outgoing transitions in the chart inherit
the property setting. You cannot mix explicit and implicit ordering in the same Stateflow
chart. However, you can mix charts with different ordering in the same Simulink model.
3-60
Evaluation Order for Outgoing Transitions
You can control the behavior of the Stateflow diagnostic that detects transition
shadowing. On the Diagnostics > Stateflow pane of the Configuration Parameters
dialog box, set Unreachable execution path to none, warning, or error. For
information about other diagnostics, see Model Configuration Parameters: Stateflow
Diagnostics (Simulink).
When you open a new Stateflow chart, all outgoing transitions from a source are
automatically numbered in the order you create them, starting with the next available
number for the source.
You can change the order of outgoing transitions by explicitly renumbering them. When
you change a transition number, the Stateflow chart automatically renumbers the other
outgoing transitions for the source by preserving their relative order. This behavior is
consistent with the renumbering rules for Simulink ports.
For example, if you have a source with five outgoing transitions, changing transition 4 to
2 results in the automatic renumbering shown.
3-61
3 Stateflow Chart Semantics
1 Right-click inside the top level of a chart and select Properties from the context
menu.
3-62
Evaluation Order for Outgoing Transitions
3 Click OK.
3-63
3 Stateflow Chart Semantics
Note: If you select Execution Order while the chart is in implicit ordering mode,
the only option available is Enable user-specified execution order for this
chart. This option opens the Chart properties dialog box where you can switch
to explicit ordering mode, as described in Order Transitions Explicitly on page
3-62.
A context menu of available transition numbers appears, with a check mark next to
the current number for this transition.
2 Select the new transition number.
The chart automatically renumbers the other transitions for the source by preserving
the relative transition order.
3 Repeat this procedure to renumber other transitions as needed.
Another way to access the transition order number is through the properties dialog box.
Note: If explicit ordering mode is enabled, the chart assigns the new number to
the current transition and automatically renumbers the other transitions. If the
chart is in implicit ordering mode, an error dialog box appears and the old number is
retained.
For C charts in implicit ordering mode, a Stateflow chart evaluates a group of outgoing
transitions from a single source based on these factors (in descending order of priority):
3-64
Evaluation Order for Outgoing Transitions
Note: Implicit ordering creates a dependency between design layout and evaluation
priority. When you rearrange transitions in your chart, you can accidentally change order
of evaluation and affect simulation results. For more control over your designs, use the
default explicit ordering mode to set evaluation priorities.
Order by Hierarchy
3-65
3 Stateflow Chart Semantics
Because the chart is at a higher level in the hierarchy than state A, the transition from
state A1 to state B takes precedence over the transition from state A1 to state A2.
Order by Label
A chart evaluates a group of outgoing transitions with equal hierarchical priority based
on the labels, in the following order of precedence:
A chart evaluates a group of outgoing transitions with equal hierarchical and label
priority based on angular position on the surface of the source object. The transition with
the smallest clock position has the highest priority. For example, a transition with a
2 o'clock source position has a higher priority than a transition with a 4 o'clock source
position. A transition with a 12 o'clock source position has the lowest priority.
Note: These evaluations proceed in a clockwise direction around the source object.
3-66
Evaluation Order for Outgoing Transitions
For each outgoing transition from state A, the parent is the chart and the label
contains a condition. Therefore, the outgoing transitions have equal hierarchical and
label priority.
The conditions [C_one == 1] and [C_two == 2] are false, and the condition [C_three
== 3] is true.
The chart evaluates the outgoing transitions from state A in this order.
3-67
3 Stateflow Chart Semantics
For each outgoing transition from the junction, the parent is the chart and the label
contains a condition. Therefore, the outgoing transitions have equal hierarchical and
label priority.
The conditions [C_one == 1] and [C_two == 2] are false, and the conditions [C_three
== 3] and [C_four == 4] are true.
The junction source point for the transition to state E is exactly 12 o'clock.
The chart evaluates the outgoing transitions from the junction in this order.
Since the transition to state D occurs, the chart does not evaluate the transition to state
E.
3-68
Evaluation Order for Outgoing Transitions
1 Right-click inside the top level of the chart and select Properties from the context
menu.
2 In the Chart properties dialog box, clear the User specified state/transition
execution order check box.
3 Click OK.
What Happens When You Switch Between Explicit and Implicit Ordering
If you switch to implicit ordering mode in a C chart after explicitly ordering transitions,
the transition order resets to follow the implicit rules. Similarly, if you switch back to
explicit ordering mode, without changing the chart, you can restore the previous explicit
transition order. All existing transitions in a chart retain their current order numbers
until you explicitly change them.
Note: If you change back to explicit ordering after modifying the chart, you might not be
able to restore the previous explicit transition order.
By default, charts use explicit ordering for transitions. In this mode, you have explicit
control over the testing priority, as described in Explicit Ordering of Outgoing
Transitions on page 3-61.
If you use implicit ordering for transitions, the following testing order applies. For each
group of transitions that originate from the same state, tiebreaking criteria apply in this
order: hierarchy, label, and angular position.
3-69
3 Stateflow Chart Semantics
The following chart shows the behavior of multilevel transition testing. Assume that the
Super1.Sub1.Subsub1 state is active.
3-70
Evaluation Order for Outgoing Transitions
Because the chart uses implicit ordering, the following transition testing order applies:
3-71
3 Stateflow Chart Semantics
Suppose that you open the sf_debouncer model and reach the point in the simulation
where the Debounce.On state is active.
Because the chart uses implicit ordering, the following transition testing order applies:
3-72
Evaluation Order for Outgoing Transitions
Because the chart uses implicit ordering, the following transition testing order applies:
For more information on how this model works, see Key Behaviors of Debouncer Chart
on page 24-3.
3-73
3 Stateflow Chart Semantics
A state performs its entry action (if specified) when it becomes active. The state becomes
active before its entry action executes and completes.
1 If the parent of the state is not active, perform steps 1 through 4 for the parent first.
2 If the state is a parallel state, check if a sibling parallel state previous in entry order
is active. If so, start at step 1 for this parallel state.
Parallel (AND) states are ordered for entry based on whether you use explicit
ordering (default) or implicit ordering. For details, see Explicit Ordering of Parallel
States on page 3-79 and Implicit Ordering of Parallel States on page 3-80.
3 Mark the state active.
4 Perform any entry actions.
5 Enter children, if needed:
a If the state contains a history junction and there is an active child of this state at
some point after the most recent chart initialization, perform the entry actions
for that child. Otherwise, execute the default flow paths for the state.
b If this state has children that are parallel states (parallel decomposition),
perform entry steps 1 through 5 for each state according to its entry order.
3-74
Process for Entering, Executing, and Exiting States
c If this state has only one child substate, the substate becomes active when the
parent becomes active, regardless of whether a default transition is present.
Entering the parent state automatically makes the substate active. The presence
of any inner transition has no effect on determining the active substate.
6 If the state is a parallel state, perform all entry steps for the sibling state next in
entry order.
7 If the transition path parent is not the same as the parent of the current state,
perform entry steps 6 and 7 for the immediate parent of this state.
8 The chart goes to sleep.
1 Execute the set of outer flow charts (see Order of Execution for a Set of Flow
Charts on page 3-58).
Note: Stateflow charts process these actions based on their order of appearance in
state labels.
3 Execute the set of inner flow charts.
If this action does not cause a state transition, the active children execute, starting
at step 1. Parallel states execute in the same order that they become active.
3-75
3 Stateflow Chart Semantics
1 Sibling parallel states exit starting with the last-entered and progress in reverse
order to the first-entered. See step 2 of Steps for Entering a State on page 3-74.
2 If a state has active children, performs the exit actions of the child states in the
reverse order from when they became active.
3 Perform any exit actions.
4 Mark the state as inactive.
3-76
Process for Entering, Executing, and Exiting States
3-77
3 Stateflow Chart Semantics
Unlike exclusive (OR) states, parallel states do not typically use transitions. Instead,
order of execution depends on:
Explicit ordering
Specify explicitly the execution order of parallel states on a state-by-state basis (see
Explicit Ordering of Parallel States on page 3-79).
Implicit ordering
Override explicit ordering by letting a Stateflow chart use internal rules to order
parallel states (see Implicit Ordering of Parallel States on page 3-80).
Parallel states are assigned priority numbers based on order of execution. The lower the
number, the higher the priority. The priority number of each state appears in the upper
right corner.
Because execution order is a chart property, all parallel states in the chart inherit the
property setting. You cannot mix explicit and implicit ordering in the same Stateflow
3-78
Execution Order for Parallel States
chart. However, you can mix charts with different ordering modes in the same Simulink
model.
When you open a new Stateflow chart or one that does not yet contain any parallel
states the chart automatically assigns priority numbers to parallel states in the order
you create them. Numbering starts with the next available number within the parent
container.
When you enable explicit ordering in a chart that contains implicitly ordered parallel
states, the implicit priorities are preserved for the existing parallel states. When you add
new parallel states, execution order is assigned in the same way as for new Stateflow
charts in order of creation.
You can reset execution order assignments at any time on a state-by-state basis, as
described in Set Execution Order for Parallel States Individually on page 3-80.
When you change execution order for a parallel state, the Stateflow chart automatically
renumbers the other parallel states to preserve their relative execution order. For details,
see Order Maintenance for Parallel States on page 3-81.
1 Right-click inside the top level of the chart and select Properties from the context
menu.
3-79
3 Stateflow Chart Semantics
If your chart already contains parallel states that have been ordered implicitly, the
existing priorities are preserved until you explicitly change them. When you add new
parallel states in explicit mode, your chart automatically assigns priorities based on
order of creation (see How Explicit Ordering Works on page 3-79). However you
can now explicitly change execution order on a state-by-state basis, as described in
Set Execution Order for Parallel States Individually on page 3-80.
In explicit ordering mode, you can change the execution order of individual parallel
states. Right-click the parallel state of interest and select a new priority from the
Execution Order menu.
In implicit ordering mode, a Stateflow chart orders parallel states implicitly based on
location. Priority goes from top to bottom and then left to right, based on these rules:
The higher the vertical position of a parallel state in the chart, the higher the
execution priority for that state.
Among parallel states with the same vertical position, the leftmost state receives
highest priority.
The following example shows how these rules apply to top-level parallel states and
parallel substates.
3-80
Execution Order for Parallel States
Note: Implicit ordering creates a dependency between design layout and execution
priority. When you rearrange parallel states in your chart, you can accidentally change
order of execution and affect simulation results. For more control over your designs, use
the default explicit ordering mode to set execution priorities.
1 Right-click inside the top level of the chart and select Properties from the context
menu.
2 In the Chart properties dialog box, clear the User specified state/transition
execution order check box.
3 Click OK.
3-81
3 Stateflow Chart Semantics
For explicit ordering, a chart preserves the user-specified priorities. Consider this
example of explicit ordering:
Because of explicit ordering, the priority of each state and substate matches the order of
creation in the chart. The chart reprioritizes the parallel states and substates when you
perform these actions:
3-82
Execution Order for Parallel States
The chart preserves the priority set explicitly for top-level state b, but renumbers all
other parallel states to preserve their prior relative order.
For implicit ordering, a chart preserves the intended relative priority based on geometry.
Consider this example of implicit ordering:
If you remove top-level state b and substate e, the chart automatically reprioritizes the
remaining parallel states and substates to preserve implicit geometric order:
However, in explicit ordering mode, a chart cannot always reinstate the original
execution priority to a restored state. It depends on how you restore the state.
If you remove a state by... And restore the state by... What is the priority?
Deleting, cutting, dragging Using the undo command The original priority is
outside the boundaries restored.
of the parent state, or
dragging so its boundaries
overlap the parent state
3-83
3 Stateflow Chart Semantics
If you remove a state by... And restore the state by... What is the priority?
Dragging outside the Dragging it back into the The original priority is lost.
boundaries of the parent parent state The Stateflow chart treats
state or so its boundaries the restored state as the last
overlap the parent state and created and assigns it the
releasing the mouse button lowest execution priority.
Dragging outside the Dragging it back into the The original priority is
boundaries of the parent parent state restored.
state or so its boundaries
overlap the parent state
without releasing the mouse
button
Dragging so its boundaries Dragging it to a location The original priority is
overlap one or more sibling with no overlapping restored.
states boundaries inside the same
parent state
Cutting Pasting The original priority is lost.
The Stateflow chart treats
the restored state as the last
created and assigns it the
lowest execution priority.
When you convert a state with parallel decomposition into a subchart, its substates
retain their relative execution order based on the prevailing explicit or implicit rules.
3-84
Early Return Logic for Event Broadcasts
3-85
3 Stateflow Chart Semantics
In this example, assume that state A is initially active. Event E occurs, causing the
following behavior:
1 The chart root checks to see if there is a valid transition out of the active state A as a
result of event E.
2 A valid transition to state B exists.
3 The condition action of the valid transition executes and broadcasts event F.
3-86
Early Return Logic for Event Broadcasts
State C is now the only active child of its chart. The Stateflow chart cannot return to the
transition from state A to state B and continue after the condition action that broadcast
event F (step 3). First, its source, state A, is no longer active. Second, if the chart allowed
the transition, state B would become the second active child of the chart. This behavior
violates the guideline that a state (or chart) with exclusive (OR) decomposition can never
have more than one active child. Therefore, the chart uses early return logic and halts
the transition from state A to state B.
Tip: Avoid using undirected local event broadcasts, which can cause unwanted recursive
behavior in your chart. Use the send operator for directed local event broadcasts. For
more information, see Broadcast Events to Synchronize States on page 11-52.
You can set the diagnostic level for detecting undirected local event broadcasts. In the
Model Configuration Parameters dialog box, go to the Diagnostics > Stateflow pane
and set the Undirected event broadcasts diagnostic to none, warning, or error. The
default setting is warning.
3-87
4
If your system has no operating modes, the system is stateless. If your system has
operating modes, the system is modal.
Classic The default machine type. Provides the full set of semantics for MATLAB
charts and C charts.
4-2
Basic Approach for Modeling Event-Driven Systems
For more information , see How Chart Constructs Interact During Execution on
page 3-8, Differences Between MATLAB and C as Action Language Syntax on page
12-7, and Overview of Mealy and Moore Machines on page 6-2.
1 For each state, what are the actions you want to perform?
2 What are the rules for transitioning between your states? If your chart has no states,
what are the rules for transitioning between branches of your flow logic?
Using your answers to those questions, specify state actions and transition conditions:
1 Draw states to represent your operating modes, if any. See Represent Operating
Modes Using States on page 4-5.
2 Implement the state actions by adding state labels that use the appropriate syntax.
See State Action Types on page 11-2.
3 Draw transitions to represent the direction of flow logic, between states or between
branches of your flow chart. See Transition Between Operating Modes on page
4-18.
4 Implement the transition conditions by adding transition labels that use the
appropriate syntax. See Transition Action Types on page 11-8.
1 Add local data to the appropriate level of the chart hierarchy. See Add Stateflow
Data on page 8-2.
You can also use the Symbol Wizard to add data to your chart. See Define Chart
Symbols with the Symbol Wizard on page 28-33.
2 Specify the type, size, complexity, and other data properties. See Set Data
Properties on page 8-6.
4-3
4 Create Stateflow Charts
Flow chart Encapsulate flow charts containing if-then-else, switch-case, for, while,
or do-while patterns.
MATLAB Write matrix-oriented algorithms; call MATLAB functions for data
analysis and visualization.
Simulink Call Simulink function-call subsystems directly to streamline design and
improve readability.
Truth table Represent combinational logic for decision-making applications such as
fault detection and mode switching.
Use the function format that is most natural for the type of calculation in the state action
or transition condition. For more information on the four types of functions, see:
If the four types of Stateflow functions do not work, you can write your own C or C
++ code for integration with your chart. For more information about custom code
integration, see Share Data Using Custom C Code on page 28-25.
To create a new chart, repeat all the steps in this basic workflow.
To add hierarchy, repeat the previous three steps on lower levels of the current
chart.
4-4
Represent Operating Modes Using States
Create a State
You create states by drawing them in the editor for a particular chart (block). Follow
these steps:
In the drawing area, the pointer becomes state-shaped (rectangular with oval
corners).
3 Click in a particular location to create a state.
The created state appears with a question mark (?) label in its upper left-hand
corner.
4 Click the question mark.
The label for a state specifies its required name and optional actions. See Label States
on page 4-15 for more detail.
4-5
4 Create Stateflow Charts
When your pointer is over a corner, it appears as a double-ended arrow (PC only;
pointer appearance varies with other platforms).
2 Click and drag the state's corner to resize the state and release the left mouse
button.
Note: A parent state must be graphically large enough to accommodate all its substates.
You might need to resize a parent state before dragging a new substate into it. You
can bypass the need for a state of large graphical size by declaring a superstate to be a
subchart. See Encapsulate Modal Logic Using Subcharts on page 7-5 for details.
Group States
When to Group a State
Group a state to move all graphical objects inside a state together. When you group a
state, the chart treats the state and its contents as a single graphical unit. This behavior
simplifies editing of a chart. For example, moving a grouped state moves all substates
and functions inside that state.
4-6
Represent Operating Modes Using States
You can group a state by right-clicking it and then selecting Group & Subchart >
Group in the context menu. The state appears shaded in gray to indicate that it is now
grouped.
If you try to move objects such as states and graphical functions into a grouped
state, you see an invalid intersection error message. Also, the objects with an invalid
intersection have a red border.
You can ungroup a state by right-clicking it and then clearing Group & Subchart >
Group in the context menu. The background of the state no longer appears gray.
4-7
4 Create Stateflow Charts
To alter a state's decomposition, select the state, right-click to display the state's
Decomposition context menu, and select OR (Exclusive) or AND (Parallel) from the
menu.
You can also specify the state decomposition of a chart. In this case, the Stateflow
chart treats its top-level states as substates. The chart creates states with exclusive
decomposition. To specify a chart's decomposition, deselect any selected objects, right-
click to display the chart's Decomposition context menu, and select OR (Exclusive) or
AND (Parallel) from the menu.
4-8
Represent Operating Modes Using States
By default, when you create a new Stateflow chart, explicit ordering applies. In this
case, you specify the activation order on a state-by-state basis.
You can also override explicit ordering by letting the chart order parallel states based
on location. This mode is known as implicit ordering.
For more information, see Explicit Ordering of Parallel States on page 3-79 and
Implicit Ordering of Parallel States on page 3-80.
Note: The activation order of a parallel state appears in its upper right corner.
The State properties dialog box appears. For descriptions of properties, see
Properties You Can Set in the General Pane on page 4-9 and Properties You
Can Set in the Logging Pane on page 4-11.
2 Modify property settings and then click one of these buttons:
Apply to save the changes and keep the State dialog box open
Cancel to return to the previous settings
OK to save the changes and close the dialog box
Help to display the documentation in an HTML browser window
The General pane of the State properties dialog box appears as shown.
4-9
4 Create Stateflow Charts
Property Description
Name Stateflow chart name; read-only; click this hypertext link to
bring the state to the foreground.
Execution order Set the execution order of a parallel (AND) state. This
property does not appear for exclusive (OR) states. See
Execution Order for Parallel States on page 3-78.
4-10
Represent Operating Modes Using States
Property Description
Create data for Select this option to create state activity data. See About
monitoring Active State Data on page 22-30.
Function Inline Select one of these options to control the inlining of state
Option functions in generated code:
Auto
The Logging pane of the State properties dialog box appears as shown.
4-11
4 Create Stateflow Charts
Property Description
Log self activity Saves the self activity value to the MATLAB workspace
during simulation.
Test point Designates the state as a test point that can be monitored
with a floating scope during model simulation. You can also
4-12
Represent Operating Modes Using States
Property Description
log test point values into MATLAB workspace objects. See
Monitor Test Points in Stateflow Charts on page 29-44.
Logging name Specifies the name associated with the logged self activity.
Simulink software uses the signal name as its logging name
by default. To specify a custom logging name, select Custom
from the list box and enter the new name in the adjacent edit
field.
Limit data points to Limits the self activity logged to the most recent samples.
last
Decimation Limits self activity logged by skipping samples. For example,
a decimation factor of 2 saves every other sample.
The Documentation pane of the State properties dialog box appears as shown.
4-13
4 Create Stateflow Charts
Property Description
Description Textual description or comment.
Document link Enter a URL address or a general MATLAB
command. Examples are www.mathworks.com,
mailto:email_address, and edit /spec/data/
speed.txt.
4-14
Represent Operating Modes Using States
Label States
The label for a state specifies its required name for the state and the optional actions
executed when the state is entered, exited, or receives an event while it is active.
name/
entry:entry actions
during:during actions
exit:exit actions
bind:data and events
on event_or_message_name:on event_or_message_name actions
and and
4-15
4 Create Stateflow Charts
Initially, a state's label is empty. The Stateflow chart indicates this by displaying a ? in
the state's label position (upper left corner). Begin labeling the state by entering a name
for the state with the following steps:
The state turns to its highlight color and a question mark character appears in the
upper left-hand corner of the state.
2 Click the ? to edit the label.
Enter the state's name in the first line of the state's label. Names are case sensitive.
To avoid naming conflicts, do not assign the same name to sibling states. However,
you can assign the same name to states that do not share the same parent.
After labeling the state, click outside it. Otherwise, continue entering actions. To
reedit the label, click the label text near the character position you want to edit.
Enter Actions
After entering the name of the state in the label, you can enter actions for any of the
following action types:
Entry Actions begin on a new line with the keyword entry or en, followed by a
colon, followed by one or more action statements on one or more lines. To separate
multiple actions on the same line, use a comma or a semicolon.
You can begin entry actions on the same line as the state's name. In this case, begin
the entry action with a forward slash (/) instead of the entry keyword.
Exit Actions begin on a new line with the keyword exit or ex, followed by a
colon, followed by one or more action statements on one or more lines. To separate
multiple actions on the same line, use a comma or a semicolon.
4-16
Represent Operating Modes Using States
During Actions begin on a new line with the keyword during or du, followed by
a colon, followed by one or more action statements on one or more lines. To separate
multiple actions on the same line, use a comma or a semicolon.
Bind Actions begin on a new line with the keyword bind followed by a colon,
followed by one or more data or events on one or more lines. To separate multiple
actions on the same line, use a comma or a semicolon.
On Actions begin with the keyword on, followed by a space and the name of an
event or message, followed by a colon, followed by one or more action statements on
one or more lines, for example
on ev1: exit();
To separate multiple actions on the same line, use a comma or a semicolon. If you
want different events to trigger different actions, enter multiple on blocks in the state
label. Each block specifies the action for a specific event or message, for example:
on ev1: action1(); on ev2: action2();
The execution of the actions you enter for a state is dependent only on their action type,
and not the order in which you enter actions in the label. If you do not specify the action
type explicitly for a statement, the chart treats that statement as an entry action.
Tip: You can also edit the label in the properties dialog box for the state. See Change
State Properties on page 4-9.
4-17
4 Create Stateflow Charts
Create a Transition
Follow these steps to create transitions between states and junctions:
Transitions do not attach to the corners of states. Corners are used exclusively for
resizing.
Transitions exit a source and enter a destination at angles perpendicular to the source
or destination surface.
All transitions have smart behavior.
To delete a transition, click it and select Edit > Cut, or press the Delete key.
See the following sections for help with creating self-loop and default transitions:
4-18
Transition Between Operating Modes
Label Transitions
Transition labels contain syntax that accompanies the execution of a transition. The
following topics discuss creating and editing transition labels:
For more information on transition concepts, see Transition Label Notation on page
2-21.
For more information on transition label contents, see Transition Action Types on page
11-8.
The transition changes to its highlight color and a question mark (?) appears on the
transition. The ? character is the default empty label for transitions.
2 Left-click the ? to edit the label.
To apply and exit the edit, deselect the object. To reedit the label, simply left-click the
label text near the character position you want to edit.
4-19
4 Create Stateflow Charts
Transitions do not need labels. You can specify some, all, or none of the parts of the label.
Rules for writing valid transition labels include:
Can have any alphanumeric and special character combination, with the exception of
embedded spaces
Cannot begin with a numeric character
Can have any length
Can have carriage returns in most cases
Must have an ellipsis (...) to continue on the next line
Move Transitions
You can move transition lines with a combination of several individual movements.
These movements are described in the following topics:
In addition, transitions move along with the movements of states and junctions.
You can move or "bow" transition lines with the following procedure:
1 Place your pointer on the transition at any point along the transition except the
arrow or attach points.
2 Click and drag your pointer to move the transition point to another location.
Only the transition line moves. The arrow and attachment points do not move.
3 Release the mouse button to specify the transition point location.
4-20
Transition Between Operating Modes
The result is a bowed transition line. Repeat the preceding steps to move the transition
back into its original shape or into another shape.
You can move the source or end points of a transition to place them in exact locations as
follows:
1 Place your pointer over an attach point until it changes to a small circle.
2 Click and drag your pointer to move the attach point to another location.
3 Release the mouse button to specify the new attach point.
The appearance of the transition changes from a solid to a dashed line when you detach
and release a destination attach point. Once you attach the transition to a destination,
the dashed line changes to a solid line.
The appearance of the transition changes to a default transition when you detach and
release a source attach point. Once you attach the transition to a source, the appearance
returns to normal.
You can move transition labels to make the Stateflow chart more readable. To move a
transition label, do the following:
If you mistakenly click and then immediately release the left mouse button on the label,
you will be in edit mode for the label. Press the Esc key to deselect the label and try
again. You can also click the mouse on an empty location in the chart to deselect the
label.
4-21
4 Create Stateflow Charts
1 Create the transition by clicking and dragging from the source state or junction.
2 Press the S key or right-click your mouse to enable a curved transition.
3 Continue dragging the transition tip back to a location on the source state or
junction.
Click the Default Transition button in the toolbar and click a location in the
drawing area close to the state or junction you want to be the destination for the default
transition. Drag your pointer to the destination object to attach the default transition.
The size of the endpoint of the default transition is proportional to the arrowhead size.
See Change Transition Arrowhead Size on page 4-21.
Default transitions can be labeled just like other transitions. See Label Default
Transitions on page 2-35 for an example.
4-22
Transition Between Operating Modes
4-23
4 Create Stateflow Charts
4-24
Transition Between Operating Modes
Field Description
Source Source of the transition; read-only; click the hypertext
link to bring the transition source to the foreground.
Destination Destination of the transition; read-only; click the
hypertext link to bring the transition destination to
the foreground.
Parent Parent of this state; read-only; click the hypertext link
to bring the parent to the foreground.
Execution order The order in which the chart executes the transition.
Label The transition's label. See Transition Label Notation
on page 2-21 for more information on valid label
formats.
Description Textual description or comment.
Document link Enter a Web URL address or a general MATLAB
command. Examples are www.mathworks.com,
mailto:email_address, and edit/spec/data/
speed.txt.
2 After making changes, click one of these buttons:
Apply to save the changes and keep the Transition dialog box open.
Cancel to return to the previous settings for the dialog box.
OK to save the changes and close the dialog box.
Help to display Stateflow online help in an HTML browser window.
4-25
4 Create Stateflow Charts
Stateflow Editor
Use the Stateflow Editor to draw, zoom, modify, print, and save a chart shown in the
window.
Command Result
sfnew Creates an chart with the default action
language. For more information, see
sfnew.
sfnew -matlab Creates an empty chart with MATLAB as
the action language.
sfnew -C Creates an empty C chart.
4-26
Stateflow Editor Operations
Command Result
stateflow Creates an empty chart with the default
action language and displays the
Stateflow block library.
Title bar
4-27
4 Create Stateflow Charts
The full chart name appears here in model name/chart name* format. The *
character appears on the end of the chart name for a newly created chart or for an
existing chart that has been edited but not saved yet.
Menu bar and toolbar
Most editor commands are available from the menu bar. The toolbar contains buttons
for cut, copy, paste, and other commonly used editor commands. You can identify each
tool of the toolbar by placing your pointer over it until an identifying tool tip appears.
The toolbar also contains buttons for navigating a chart's subchart hierarchy (see
Navigate Subcharts on page 7-9).
Object palette
4-28
Stateflow Editor Operations
Displays a set of tools for drawing states, transitions, and other chart objects. To add
an object, you can use the palette to:
Click the icon for the object and move the cursor to the spot in the drawing area
where you want to place the object.
Drag the icon for the object into the drawing area.
Double-click the icon and then click multiple times in the drawing area to make
copies of the object.
Explorer bar
4-29
4 Create Stateflow Charts
The breadcrumb shows the systems that you have open in the editor. Click a system
in the breadcrumb to display that system.
Model Browser
Click the double arrows in the bottom left corner to open or close a tree-
structured view of the model in the editor.
Drawing area This area displays an editable copy of a chart.
Context menus (shortcut menus) These menus pop up from the drawing area
when you right-click an object. They display commands that apply only to that object.
If you right-click an empty area of the chart, the shortcut menu applies to the chart
object.
Status information Near the top of the editor, you can see (and reset) the
simulation time and the simulation mode. The bottom status bar displays the status
of the Stateflow processing, tool tips, the zoom factor, and the solver.
4-30
Stateflow Editor Operations
You can undo and redo many operations you complete on Stateflow objects in the
Symbols or Property Inspector windows.
You can undo or redo all editor operations, with the following exceptions:
You cannot undo the operation of turning subcharting off for a state previously
subcharted.
Note: When you perform one of the preceding operations, the undo and redo buttons
are disabled from undoing and redoing any prior operations.
4-31
4 Create Stateflow Charts
The Colors & Fonts dialog box helps you specify a color scheme for the chart as a whole,
or colors and label fonts for different types of objects in a chart.
To display the Colors & Fonts dialog box, in the Stateflow Editor, select File > Stateflow
Preferences > Style.
The drawing area of the dialog box displays examples of the types of objects whose colors
and font labels you can specify. The examples use the colors and label fonts specified by
4-32
Stateflow Editor Operations
the current color scheme for the chart. To choose another color scheme, select the scheme
from the dialog box's Schemes menu. The dialog box displays the selected color scheme.
Click Apply to apply the selected scheme to the chart or OK to apply the scheme and
dismiss the dialog box.
To make the selected scheme the default scheme for all charts, select Make this the
"Default" scheme from the dialog box's Options menu.
To modify the current scheme, position your pointer over the example of the type of object
whose color or label font you want to change. Then left-click to change the object's color or
right-click to change the object's font. If you left-click, a color chooser dialog box appears.
Use the dialog box to select a new color for the selected object type.
If the selected object is a label and you right-click, a font selection dialog box appears.
4-33
4 Create Stateflow Charts
Use the font selector to choose a new font for the selected label.
To save changes to the default color scheme, select Save defaults to disk from the
Colors & Fonts dialog box's Options menu.
Note: Choosing Save defaults to disk has no effect if the modified scheme is not the
default scheme.
4-34
Stateflow Editor Operations
For example, the Temporal Logic chart uses content preview. The chart Without
Temporal Logic does not.
To turn on content preview for Stateflow charts and subcharts, right-click the chart and
select Format > Content Preview. For Simulink functions, right-click the function
and select Content Preview. For details on content preview in Simulink, see Preview
Content of Hierarchical Items (Simulink).
Note: In order to see the content preview, you may need to enlarge the Stateflow chart or
object.
4-35
4 Create Stateflow Charts
options for keywords, data, event, messages, and function names, without having to
navigate the Model Explorer. In a Stateflow chart, to complete entries:
1 Type the first few characters of the word that you want.
2 Press Tab to see the list of possible matches.
3 Use the arrow keys to select a word.
4 Press Tab to make the selection.
Close the list without selecting anything by pressing the Esc key.
Type additional characters onto your original term to narrow the list of possible
matches.
If you press Tab and no words are listed, then the current word is the only possible
match.
Keyword
Comment
Event
Message
Function
String
Number
The following chart illustrates the default highlighting for language elements.
4-36
Stateflow Editor Operations
If the parser cannot resolve a syntax element, the chart displays the element in the
default text color.
To modify color assignments, see Edit Syntax Highlighting on page 4-37. To disable
syntax highlighting, see Enable and Disable Syntax Highlighting on page 4-37.
1 In the Stateflow Editor, select File > Stateflow Preferences > Syntax
Highlighting.
1 In the Stateflow Editor, select File > Stateflow Preferences > Syntax
Highlighting.
4-37
4 Create Stateflow Charts
This step adds objects to the list of already selected objects unless an object was
already selected, in which case, the object is deselected. This type of multiple object
selection is useful for selecting objects within a state without selecting the state itself.
To deselect all selected objects, click in the drawing area, but not on an object.
When an object is selected, it appears highlighted in the color set as the selection color
(blue by default; see Specify Colors and Fonts in a Chart on page 4-31 for more
information).
To cut an object, right-click the object and select Cut from the context menu.
To paste the most recently cut selection of objects, right-click in the chart and select
Paste from the context menu.
4-38
Stateflow Editor Operations
Note: If you copy and paste a state in the chart, these rules apply:
If the original state uses the default ? label, then the new state retains that label.
If the original state does not use the default ? label, then a unique name is generated
for the new state.
Alternatively, to copy from one chart to another, select Copy and then Paste from the
right-click context menu.
Alignment
Distribution
Resizing
States
Functions
Boxes
4-39
4 Create Stateflow Charts
Junctions
The basic steps to align, distribute, or resize chart objects are similar.
1 If the chart includes parallel states or outgoing transitions from a single source,
make sure that the chart uses explicit ordering.
To set explicit ordering, in the Chart properties dialog box, select User specified
state/transition execution order.
Note: If a chart uses implicit ordering to determine execution order of parallel states
or evaluation order of outgoing transitions, the order can change after you align,
distribute, or resize chart objects. Using explicit ordering prevents this change from
occurring. For more information, see Execution Order for Parallel States on page
3-78 and Evaluation Order for Outgoing Transitions on page 3-60.
2 Select the chart objects that you want to align, distribute, or resize.
You can select objects in any order, one-by-one or by drawing a box around them.
3 Decide which object to use as the anchor for aligning, distributing, or resizing other
chart objects. This object is the reference object.
To set an object as the reference, right-click the object. Brackets appear around the
reference object. In the following example, the Door and Motion states are selected,
and the Door state is the reference.
4-40
Stateflow Editor Operations
Note: If you select objects one-by-one, the last object that you select acts as the
reference.
4 Select an option from the Chart > Arrange menu to align, distribute, or resize your
chosen objects.
For more information about chart object distribution options, see Options for
Distributing Chart Objects on page 4-41
4-41
4 Create Stateflow Charts
Suppose that you open the sf_pool model and see a chart with multiple MATLAB
functions.
4-42
Stateflow Editor Operations
1 Type sf_pool at the MATLAB command prompt to open the model. Double-click the
Pool block to open the chart.
4-43
4 Create Stateflow Charts
This object is the reference (or anchor) for aligning the three functions. Brackets
appear around the function.
This step aligns the right edges of the three functions based on the right edge of
getBallInteraction.
4-44
Stateflow Editor Operations
Suppose that you open the sf_frame_sync_controller model and see a chart with
three states.
4-45
4 Create Stateflow Charts
Tip: Double-click the Frame Sync Controller block to open the chart.
2 Select the three states in any order.
4-46
Stateflow Editor Operations
4-47
4 Create Stateflow Charts
Note: When you select the three states in any order, your reference object might
differ from the one shown. This difference does not affect distribution of vertical
white space.
3 Select Chart > Arrange > Even Vertical Gaps.
This step ensures that the vertical white space between any two states is the same.
Suppose that you open the sf_clutch model and see a chart with graphical functions of
different sizes.
To resize the graphical functions so that they all match the size of detectSlip:
4-48
Stateflow Editor Operations
This step ensures that the three functions are the same size.
4-49
4 Create Stateflow Charts
a To align the functions, select Chart > Arrange > Align Left.
4-50
Stateflow Editor Operations
b To distribute the functions evenly in terms of vertical spacing, select Chart >
Arrange > Even Vertical Gaps.
4-51
4 Create Stateflow Charts
4-52
Stateflow Editor Operations
Straightens transitions.
Repositions horizontal transition labels to the midpoint.
To format your chart, select Chart > Arrange > Arrange Automatically.
4-53
4 Create Stateflow Charts
4-54
Stateflow Editor Operations
3 Enter the destination directory of the report file and select options to specify what
objects appear in the report.
For details on setting the fields in the File locations/naming options section, see
Print Model Reports (Simulink). For details on the report you receive, see System
Report Options on page 4-56 and Report Format on page 4-56.
4 Click Print.
The Print Details dialog box appears and tracks the report generation. See Print Model
Reports (Simulink) for more details on this window.
Tip: If you have the Simulink Report Generator installed, you can generate a detailed
report about a system. To do so, in the Simulink Editor, select File > Reports >
System Design Description. For more information, see System Design Description
(Simulink Report Generator).
4-55
4 Create Stateflow Charts
Reports for the current Stateflow chart vary with your choice of one of the System
reporting options fields:
Current Reports on the chart or subchart in the current editor window and its
immediate parent Simulink system.
Current and above This option is grayed out and unavailable for printing chart
details.
Current and below Reports on the chart or subchart in the current editor window
and all contents at lower levels of the hierarchy, along with the immediate Simulink
system.
Entire model Reports on the entire model including all charts and all Simulink
systems.
If you select this option, you can modify the report as follows:
Look under mask dialog Includes the contents of masked subsystems in the
report.
Expand unique library links Includes the contents of library blocks that are
subsystems in the report.
The report includes a library subsystem only once even if it occurs in more than
one place in the model.
Report Format
The report shows the title of the system in the Simulink model containing the chart or
subchart in current view.
A representation of Simulink hierarchy for the containing system and its subsystems
follows. Each subsystem in the hierarchy links to the report of its Stateflow charts.
The report section for the Stateflow charts of each system or subsystem begins with a
small report on the system or subsystem, followed by a report of each contained chart.
Each chart report includes a reproduction of its chart with links for subcharted states
that have reports of their own.
An appendix tabulates the covered Stateflow and Simulink objects in the report.
4-56
5
5-2
Difference Between Flow Charts and State Transition Diagrams
By contrast, a state transition diagram is used for sequential design. It stores its current
state in memory to preserve local data and activity between updates. As a result, state
diagrams can begin executing where they left off in the previous time step, making them
suitable for modeling reactive or supervisory systems that depend on history. In these
kinds of systems, the current result depends on a previous result.
Related Examples
Create Flow Charts with the Pattern Wizard on page 5-5
More About
States on page 2-7
Transitions on page 2-19
5-3
5 Model Logic Patterns and Iterative Loops Using Flow Charts
5-4
Create Flow Charts with the Pattern Wizard
In this section...
Why Use the Pattern Wizard? on page 5-5
How to Create Reusable Flow Charts on page 5-5
Insert a Logic Pattern Using the Pattern Wizard on page 5-7
Save and Reuse Flow Chart Patterns on page 5-10
MAAB-Compliant Patterns from the Pattern Wizard on page 5-12
Create and Reuse a Custom Pattern with the Pattern Wizard on page 5-21
Note: The Pattern Wizard is only used for flow charts, and cannot be used to save states
and subcharts. Atomic subcharts can be used to reuse states and subcharts.
1 Open a chart.
5-5
5 Model Logic Patterns and Iterative Loops Using Flow Charts
You can also add or change conditions and actions directly in the chart.
5 Click OK.
The pattern appears in your chart. The geometry and layout comply with MAAB
guidelines.
6 Customize the pattern as desired.
For example, you may want to add or change flow charts, conditions, or actions. See
Create and Reuse a Custom Pattern with the Pattern Wizard on page 5-21.
7 Save the pattern to a central location as described in Save and Reuse Flow Chart
Patterns on page 5-10.
You can now retrieve your pattern directly from the editor to reuse in graphical functions
and charts. See How to Add Flow Chart Patterns in Graphical Functions on page
5-11 and How to Add Flow Chart Patterns in Charts on page 5-11.
5-6
Create Flow Charts with the Pattern Wizard
If your selection is not eligible, when you select Chart > Insert Pattern on Selection,
you see a message instead of pattern options.
Message Issue
Select a vertical transition You have not selected a vertical transition.
Selected transition must be exactly vertical You selected a transition, but it is not
vertical.
Select only one vertical transition You have selected more than one
transition.
Editor must contain only transitions and There are other objects, such as states,
junctions functions or truth tables in the editor.
Insert a Pattern
1 Open a chart.
2 Select Chart > Add Pattern in Chart > Loop > While.
5-7
5 Model Logic Patterns and Iterative Loops Using Flow Charts
You can also add or change conditions and actions directly in the chart.
5 Click OK.
5-8
Create Flow Charts with the Pattern Wizard
5-9
5 Model Logic Patterns and Iterative Loops Using Flow Charts
The Pattern Wizard uses a single, flat folder for saving and retrieving flow chart
patterns. Follow these guidelines when creating your pattern folder:
Store all flow charts at the top level of the pattern folder; do not create subfolders.
Make sure all flow chart files have a .mdl or .slx extension.
1 Create a folder for storing your patterns according to Guidelines for Creating a
Pattern Folder on page 5-10.
2 In your chart, select flow charts with the patterns you want to save.
3 Select Chart > Save Pattern.
The Pattern Wizard displays a message that prompts you to choose a folder for
storing custom patterns.
The Pattern Wizard stores your flow charts in the pattern folder as a model file.
The patterns that you save in this folder appear in a drop-down list when you select
Chart > Add Pattern in Chart > Custom, as described in How to Add Flow Chart
Patterns in Graphical Functions on page 5-11 and How to Add Flow Chart
Patterns in Charts on page 5-11.
4 Click OK to dismiss the message.
The Pattern Wizard saves your pattern as a model file in the designated folder.
5-10
Create Flow Charts with the Pattern Wizard
The Select a Custom Pattern dialog box appears, displaying all of your saved
patterns.
You have not saved any patterns for the Pattern Wizard to retrieve. See Save and
Reuse Flow Chart Patterns on page 5-10.
5 Select a pattern from the list in the dialog box and click OK.
The pattern appears in the graphical function, which expands to fit the flow chart.
6 Define all necessary inputs, outputs, and local data in the graphical function and the
chart that calls it.
1 In the menu bar, select Chart > Add Pattern in Chart > Custom.
5-11
5 Model Logic Patterns and Iterative Loops Using Flow Charts
The Select a Custom Pattern dialog box appears, displaying all of your saved
patterns.
2 Select a pattern from the list in the dialog box and click OK.
The Pattern Wizard generates the following MAAB-compliant decision logic patterns:
if
5-12
Create Flow Charts with the Pattern Wizard
if-else
if-elseif
5-13
5 Model Logic Patterns and Iterative Loops Using Flow Charts
if-elseif-else
5-14
Create Flow Charts with the Pattern Wizard
if-elseif-elseif-else
5-15
5 Model Logic Patterns and Iterative Loops Using Flow Charts
Nested if
The Pattern Wizard generates the following MAAB-compliant iterative loop patterns:
for
5-16
Create Flow Charts with the Pattern Wizard
while
do-while
5-17
5 Model Logic Patterns and Iterative Loops Using Flow Charts
5-18
Create Flow Charts with the Pattern Wizard
5-19
5 Model Logic Patterns and Iterative Loops Using Flow Charts
5-20
Create Flow Charts with the Pattern Wizard
Do not specify an action yet. You will add another loop for iterating the second
dimension of the matrix.
4 Click OK.
The Pattern Wizard generates the first iterative loop in your chart.
5-21
5 Model Logic Patterns and Iterative Loops Using Flow Charts
This pattern:
Conforms to all best practices for creating flow charts, as described in Best
Practices for Creating Flow Charts on page 5-31.
Provides the correct syntax for conditions and condition actions.
5 Add the second loop:
a Expand the editor window so the chart can accommodate a second pattern.
b Select the vertical transition labelled {action1}.
c Select Chart > Insert Pattern on Selection > Loop > For.
d Enter the initializer, loop test, and counting expressions for the second iterator
j, and a placeholder for an action to retrieve each element in the upper triangle
as follows:
5-22
Create Flow Charts with the Pattern Wizard
e Click OK. The Pattern Wizard adds the second loop to the first loop.
5-23
5 Model Logic Patterns and Iterative Loops Using Flow Charts
Save your pattern to a central location for reuse (see Save the Upper Triangle Iterator
Pattern for Reuse on page 5-24).
1 Create a folder for storing flow chart patterns, as described in Guidelines for
Creating a Pattern Folder on page 5-10.
2 Open the chart that contains the custom pattern.
3 In the chart, select the flow chart with the pattern that you want to save.
4 In the editor, select Chart > Save Pattern and take one of these actions.
5-24
Create Flow Charts with the Pattern Wizard
The Pattern Wizard automatically saves your pattern as a model file under the name
that you specify.
Input Description
u 2-D matrix
numrow Number of rows in the matrix
numcol Number of columns in the matrix
4 Right-click inside the function and select Group & Subchart > Subchart.
5-25
5 Model Logic Patterns and Iterative Loops Using Flow Charts
5 Double-click to open the subcharted function and select Chart > Add Pattern in
Function > Custom.
The Select a Custom Pattern dialog box opens, listing all the patterns that you have
saved in your pattern folder.
5-26
Create Flow Charts with the Pattern Wizard
The Pattern Wizard adds your custom pattern to the graphical function.
5-27
5 Model Logic Patterns and Iterative Loops Using Flow Charts
Before calling this function from a chart, be sure to modify data names, types, and sizes
as necessary and substitute an appropriate action.
5-28
Draw and Customize Flow Charts By Hand
1 Open a chart.
2 From the editor toolbar, drag one or more connective junctions into the chart using
the Connective Junction tool:
5-29
5 Model Logic Patterns and Iterative Loops Using Flow Charts
1 Right-click a connective junction and select Properties from the drop-down menu.
Field Description
Parent Parent of the connective junction (read-only). Click the
hypertext link to bring the parent to the foreground.
Description Textual description or comment.
Document link Link to other information. Enter a URL address
or a general MATLAB command. Examples are
www.mathworks.com, mailto:email_address, and
edit/spec/data/speed.txt.
3 Click Apply to save changes.
5-30
Best Practices for Creating Flow Charts
This guideline ensures that execution of a flow chart always reaches the termination
point.
Provide an unconditional transition from every junction except the terminating junction
This guideline ensures that unintended backtracking behavior does not occur in a flow
chart. If unintended backtracking occurs during simulation, a warning message appears.
You can control the level of diagnostic action for unintended backtracking in the
Diagnostics > Stateflow pane of the Model Configuration Parameters dialog box. For
more information, see the documentation for the Unexpected backtracking (Simulink)
diagnostic.
The junction does not have an unconditional transition path to a state or terminating
junction.
Multiple transition paths lead to that junction.
Flow charts test transitions, but do not execute them (and, therefore, never execute
transition actions).
5-31
5 Model Logic Patterns and Iterative Loops Using Flow Charts
5-32
6
X (n + 1) = f ( X (n),u)
In this equation:
State is a combination of local data and chart activity. Therefore, computing state means
updating local data and making transitions from a currently active state to a new state.
State persists from one time step to another.
In this context, Mealy and Moore machines each have well-defined semantics.
6-2
Overview of Mealy and Moore Machines
You can create charts that implement pure Mealy or Moore semantics as a subset of
Stateflow chart semantics (see Create Mealy and Moore Charts on page 6-5).
Mealy and Moore charts can be used in simulation and code generation with Embedded
Coder, Simulink Coder, and HDL Coder software, which are available separately.
Availability of Output
Mealy machines compute output on transitions, while Moore machines compute outputs
in states. Therefore, Mealy charts can compute output earlier than Moore charts
that is, at the time the chart's default path executes. If you enable the chart property
Execute (enter) Chart At Initialization for a Mealy chart, this computation occurs
at t = 0 (first time step); otherwise, it occurs at t = 1 (next time step). By contrast, Moore
machines can compute outputs only after the default path executes. Until then, outputs
take the default values.
6-3
6 Build Mealy and Moore Charts
You can verify the Mealy and Moore charts you create to ensure that they conform to
their formal definitions and semantic rules. Error messages appear at compile time
(not at design time).
Moore charts provide a more efficient implementation than Classic charts, both for C/
C++and HDL targets.
You can use a Moore chart to model a feedback loop. In Moore charts, inputs do not
have direct feedthrough. Therefore, you can design a loop with feedback from the
output port to the input port without introducing an algebraic loop. Mealy and Classic
charts have direct feedthrough and error with an algebraic loop.
More About
Design Considerations for Mealy Charts on page 6-8
Design Considerations for Moore Charts on page 6-11
6-4
Create Mealy and Moore Charts
1 Add a new Chart block to a Simulink model; then double-click the block to open the
Stateflow Editor.
2 Right-click in an empty area of the chart and select Properties.
Mealy Moore
5 Design your chart according to the guidelines for the chart type (see Design
Considerations for Mealy Charts on page 6-8 and Design Considerations for
Moore Charts on page 6-11.
6-5
6 Build Mealy and Moore Charts
6-6
Model a Vending Machine Using Mealy Semantics
behaves like a Mealy machine because its output soda depends on both the input coin
and current state, as follows:
When initial state got_0 is active. No coin has been received or no coins are left.
If a nickel is received (coin == 1), output soda remains 0, but state got_nickel
becomes active.
If a dime is received (coin == 2), output soda remains 0, but state got_dime
becomes active.
If input coin is not a dime or a nickel, state got_0 stays active and no soda is
released (output soda = 0).
If another nickel is received (coin == 1), state got_dime becomes active, but no can
is released (soda remains at 0).
If a dime is received (coin == 2), a can is released (soda = 1), the coins are banked,
and the active state becomes got_0 because no coins are left.
If input coin is not a dime or a nickel, state got_nickel stays active and no can is
released (output soda = 0).
If a nickel is received (coin == 1), a can is released (soda = 1), the coins are banked,
and the active state becomes got_0 because no coins are left.
If a dime is received (coin == 2), a can is released (soda = 1), 15 cents is banked, and
the active state becomes got_nickel because a nickel (change) is left.
If input coin is not a dime or a nickel, state got_dime stays active and no can is
released (output soda = 0).
6-7
6 Build Mealy and Moore Charts
Mealy Semantics
To ensure that output is a function of input and state, Mealy state machines enforce the
following semantics:
Note: A chart provides one time base for input and clock (see Calculate Output and
State Using One Time Base on page 6-10).
Chart must compute outputs whenever there is a change on the input port.
Chart must compute outputs only in transitions, not in states.
You can compute outputs only in the condition actions of outer and inner transitions. A
common modeling style for Mealy machines is to test inputs in conditions and compute
outputs in the associated action.
6-8
Design Considerations for Mealy Charts
You cannot use state actions or transition actions in Mealy charts. This restriction
enforces Mealy semantics by:
Preventing you from computing output without considering changes on the input port
Ensuring that output depends on current state and not next state
You can define inputs, outputs, local data, parameters, and constants in Mealy charts,
but other data restrictions apply:
Machine-parented data is data that you define for a Stateflow machine, which is the
collection of all Stateflow blocks in a Simulink model. The Stateflow machine is the
highest level of the Stateflow hierarchy. When you define data at this level, every chart
in the machine can read and modify the data. To ensure that Mealy charts do not access
data that can be modified unpredictably outside the chart, do not use machine-parented
data.
You cannot define data store memory (DSM) in Mealy charts because DSM objects can
be modified by objects external to the chart. A Stateflow chart uses data store memory
to share data with a Simulink model. Data store memory acts as global data that can be
modified by other blocks and models in the Simulink hierarchy that contains the chart.
Mealy charts should not access data that can change unpredictably.
Do: Do Not:
Use input events to trigger the chart Broadcast any type of event
6-9
6 Build Mealy and Moore Charts
Do: Do Not:
Use event-based temporal logic to guard Use local events to guard transitions
transitions
You cannot use local events in Mealy charts
You can use event-based temporal logic because they are not deterministic. These
in Mealy charts because it behaves events can occur while the chart computes
synchronously (see Operators for Event- outputs and, therefore, violate Mealy
Based Temporal Logic on page 11-57). semantics that require charts to compute
Think of the change in value of a temporal outputs whenever input changes.
logic condition as an event that the chart
schedules internally. Therefore, at each Use implicit events such as
time step, the chart retains its notion of chg(data_name), en(state_name), or
state because it knows how many ticks ex(state_name).
remain before the temporal event executes.
You can use one time base for clock and input, as determined by the Simulink solver (see
Solvers (Simulink)). The Simulink solver sets the clock rate to be fast enough to capture
input changes. As a result, a Mealy chart commonly computes outputs and changes
states in the same time step.
6-10
Design Considerations for Moore Charts
Moore Semantics
In Moore charts, output is a function of current state only. At every time step, a Moore
chart wakes up, computes its outputs, and then evaluates its inputs to reconfigure itself
for the next time step. For example, after evaluating its inputs, the Moore chart might
take transitions to a new configuration of active states, also called next state. However,
the Moore chart must always compute its outputs before changing state.
To ensure that output is a function only of state, Moore state machines enforce the
following semantics:
6-11
6 Build Mealy and Moore Charts
To ensure that outputs depend solely on current state, you must compute outputs in state
actions, subject to the following restrictions:
You cannot define actions on transitions because transitions almost always depend on
inputs. For example, if you compute outputs in a condition action on a transition, the
chart updates outputs whenever there is a change on the input, which is a violation of
Moore semantics.
Combine Actions
For Classic charts, you can define different types of actions in states (see State Action
Types on page 11-2). In Moore charts, you can include only one action per state. The
action for a state can consist of multiple command statements. Stateflow evaluates states
in Moore charts from the top level down. Active states in Moore charts execute the state
action before evaluating the transitions. Therefore, outputs are computed at each time
step whether an outer transition is valid or not.
Do Not Label State Actions
Do not label state actions in Moore charts with any keywords, such as en,du, or ex.
6-12
Design Considerations for Moore Charts
Machine-parented data is data that you define for a Stateflow machine. The Stateflow
machine is the highest level of the Stateflow hierarchy. When you define data at this
level, every chart in the machine can read and modify the data. To ensure that Moore
charts do not access data that can be modified unpredictably outside the chart, do not use
machine-parented data.
Do Not Define Data Store Memory
You cannot define data store memory (DSM) in Moore charts because objects external to
the chart modify DSM objects. A Stateflow chart uses data store memory to share data
with a Simulink model. Data store memory acts as global data. Other blocks and models
in the Simulink hierarchy that contains the chart can modify DSM. Moore charts must
not access data that can change unpredictably.
6-13
6 Build Mealy and Moore Charts
Here, each transition tests input u in a condition, but modifies output y in a condition
action, based on the value of the input. This construct violates Moore semantics and
triggers an error. Similarly, you cannot use transition actions in Moore charts.
Because Moore charts cannot have condition or transition actions, use states to produce
actions.
You cannot use Simulink functions in Moore charts. This restriction prevents violations
of Moore semantics during chart execution.
6-14
Design Considerations for Moore Charts
In Moore charts, you cannot set the update method to Continuous. For modeling
systems with continuous-time in Stateflow, use Classic or Mealy charts.
6-15
6 Build Mealy and Moore Charts
This chart uses temporal logic to regulate state transitions. The after operator
implements a countdown timer, which initializes when the source state is entered. By
default, the timer provides a longer green light in the East-West direction than in the
North-South direction because the volume of traffic is greater on the East-West road.
6-16
Model a Traffic Light Using Moore Semantics
The green light in the East-West direction stays on for at least 20 clock ticks, but it can
remain green as long as no traffic arrives in the North-South direction. A sensor detects
whether cars are waiting at the red light in the North-South direction. If so, the light
turns green in the North-South direction to keep traffic moving.
The Light_Controller chart behaves like a Moore machine because it updates its outputs
based on current state before transitioning to a new state, as follows:
When initial state Stop is active. Traffic light is red for North-South, green for
East-West.
In active state StopForTraffic. Traffic light has been red for North-South, green for
East-West for at least 20 clock ticks.
In active state StopToGo. Traffic light must reverse traffic flow in response to
sensor.
In active state Go. Traffic light has been red for North-South, yellow for East-West
for 3 clock ticks.
In active state GoToStop. Traffic light has been green for North-South, red for East-
West for 10 clock ticks.
6-17
6 Build Mealy and Moore Charts
6-18
Effects of Changing the Chart Type
Here is a summary of what happens when you change chart types mid-design.
From To Result
Mealy Classic Mealy charts retain their semantics when changed to Classic type.
Classic Mealy If the Classic chart confirms to Mealy semantic rules, the Mealy
chart exhibits equivalent behavior, provided that output is defined at
every time step.
Moore Classic State actions in the Moore chart behave as entry actions because
they are not labeled. Therefore, the Classic chart will not exhibit
behavior that is equivalent to the original Moore chart. Requires
redesign.
Classic Moore Actions that are unlabeled in the Classic chart ( entry actions by
default) behave as during and exit actions. Therefore, the Moore
chart will not exhibit behavior that is equivalent to the original
Classic chart. Requires redesign.
Mealy Moore Converting between these two types does not produce equivalent
Moore Mealy behavior because Mealy and Moore rules about placement of actions
are mutually exclusive. Requires redesign.
6-19
6 Build Mealy and Moore Charts
For example, recall the Mealy vending machine chart described in Model a Vending
Machine Using Mealy Semantics on page 6-6.
If you change the chart type to Moore and rebuild, you get the following diagnostic
message:
6-20
Debug Mealy and Moore Charts
This message indicates that you cannot define actions on transitions. Without actions,
you cannot compute outputs on transitions in Moore charts (see Do Not Use Actions on
Transitions on page 6-13). According to Moore semantics, you must instead compute
outputs in state actions (see Design Rules for Moore Charts on page 6-11).
In the Mealy chart, each condition action computes output (whether or not soda is
released) based on input (the coin received). Each state represents one of the three
possible coin inputs: nickel, dime, or no coin. The Mealy chart computes the output as it
transitions to the next state. When you move this logic out of transitions and into state
actions in the Moore chart, you need more states. The reason is that in the Moore chart,
each state must represent not only coins received, but also the soda release condition.
The Moore chart must compute output according to the active state before considering
input. As a result, there will be a delay in releasing soda, even if the machine receives
enough money to cover the cost.
6-21
6 Build Mealy and Moore Charts
6-22
Debug Mealy and Moore Charts
For this vending machine, Mealy is a better modeling paradigm because there is no
delay in releasing soda once sufficient coins are received. By contrast, the Moore vending
machine requires an extra time step to pass before producing soda. Since the Moore
vending machine accepts a nickel, a dime, or no coin in a given time step, it is possible
that the soda will be produced in a time step in which a coin is accepted toward the next
purchase. In this situation, the delivery of a soda may appear to be in response to this
coin, but actually occurs because the vending machine received the purchase price in
previous time steps.
6-23
7
In this section...
What Is a History Junction? on page 7-2
Create a History Junction on page 7-2
Change History Junction Size on page 7-3
Change History Junction Properties on page 7-3
To move a history junction to a new location, click and drag it to the new position.
7-2
Record State Activity Using History Junctions
7-3
7 Techniques for Streamlining Chart Design
Field Description
Parent Parent of this history junction; read-only; click the
hypertext link to bring the parent to the foreground.
Description Textual description/comment.
Document Link Enter a URL address or a general MATLAB
command. Examples are www.mathworks.com,
mailto:email_address, and edit/spec/data/
speed.txt.
3 When finished editing, click one of the following buttons:
7-4
Encapsulate Modal Logic Using Subcharts
What Is a Subchart?
A subchart is a graphical object that can contain anything a top-level chart can, including
other subcharts. A subchart, or a subcharted state, is a superstate of the states that it
contains. You can nest subcharts to any level in your chart design.
Using subcharts, you can reduce a complex chart to a set of simpler, hierarchically
organized units. This design makes the chart easier to understand and maintain, without
changing the chart behavior. Subchart boundaries do not apply during simulation and
code generation.
The subchart appears as a block with its name in the block center. However, you can
define actions and default transitions for subcharts just as you can for superstates. You
can also create transitions to and from subcharts just as you can create transitions to and
from superstates. You can create transitions between states residing outside a subchart
and any state within a subchart. The term supertransition refers to a transition that
crosses subchart boundaries in this way. See Move Between Levels of Hierarchy Using
Supertransitions on page 7-10 for more information.
Some subcharts can become atomic units if they meet certain modeling requirements.
For more information, see Restrictions for Converting to Atomic Subcharts on page
14-11.
7-5
7 Techniques for Streamlining Chart Design
Create a Subchart
You create a subchart by converting an existing state, box, or graphical function into the
subchart. The object to convert can be one that you create for making a subchart or an
existing object whose contents you want to turn into a subchart.
1 Right-click the object and select Group & Subchart > Subchart.
2 Confirm that the object now appears as a subchart.
To convert the subchart back to its original form, right-click the subchart. In the context
menu, select Group & Subchart > Subchart.
You cannot undo the operation of converting a subchart back to its original form. When
you perform this operation, the undo and redo buttons are disabled from undoing and
redoing any prior operations.
7-6
Encapsulate Modal Logic Using Subcharts
1 To convert the On state to a subchart, right-click the state and select Group &
Subchart > Subchart.
2 Confirm that the On state now appears as a subchart.
7-7
7 Techniques for Streamlining Chart Design
Open a Subchart
Opening a subchart allows you to view and change its contents. To open a subchart, do
one of the following:
7-8
Encapsulate Modal Logic Using Subcharts
Select the box representing the subchart and press the Enter key.
Edit a Subchart
After you open a subchart (see Open a Subchart on page 7-8), you can perform
any editing operation on its contents that you can perform on a top-level chart. This
means that you can create, copy, paste, cut, relabel, and resize the states, transitions,
and subcharts in a subchart. You can also group states, boxes, and graphical functions
inside subcharts.
You can also cut and paste objects between different levels in your chart. For example,
to copy objects from a top-level chart to one of its subcharts, first open the top-level chart
and copy the objects. Then open the subchart and paste the objects into the subchart.
Transitions from outside subcharts to states or junctions inside subcharts are called
supertransitions. You create supertransitions differently than you do ordinary
transitions. See Move Between Levels of Hierarchy Using Supertransitions on page
7-10 for information on creating supertransitions.
Navigate Subcharts
The Stateflow Editor toolbar contains a set of buttons for navigating the subchart
hierarchy of a chart.
Tool Description
If the Stateflow Editor is displaying a subchart, clicking this button
replaces the subchart with the subchart's parent in the Stateflow Editor.
If the Stateflow Editor is displaying a top-level chart, clicking this button
replaces the chart with the Simulink model window containing that chart.
Clicking this button shows the chart that you visited before the current
chart, so that you can navigate up the hierarchy.
Clicking this button shows the chart that you visited after visiting the
current chart, so that you can navigate down the hierarchy.
Note: You can also use the Escape key to navigate up to the parent object for a
subcharted state, box, or function.
7-9
7 Techniques for Streamlining Chart Design
In this section...
What Is a Supertransition? on page 7-10
Draw a Supertransition Into a Subchart on page 7-12
Draw a Supertransition Out of a Subchart on page 7-17
Label Supertransitions on page 7-21
What Is a Supertransition?
A supertransition is a transition between different levels in a chart, for example,
between a state in a top-level chart and a state in one of its subcharts, or between states
residing in different subcharts at the same or different levels in a chart. You can create
supertransitions that span any number of levels in your chart, for example, from a state
at the top level to a state that resides in a subchart several layers deep in the chart.
The point where a supertransition enters or exits a subchart is called a slit. Slits divide
a supertransition into graphical segments. For example, the following chart shows a
supertransition leaving the On subchart:
7-10
Move Between Levels of Hierarchy Using Supertransitions
7-11
7 Techniques for Streamlining Chart Design
7-12
Move Between Levels of Hierarchy Using Supertransitions
Note: You cannot undo the operation of drawing a supertransition. When you perform
this operation, the undo and redo buttons are disabled from undoing and redoing any
prior operations.
A supertransition appears, extending from the source state into the subchart with its
arrowhead penetrating a slit in the subchart.
7-13
7 Techniques for Streamlining Chart Design
If you are not happy with the initial position of the slit, you can continue to drag the
slit around the inside edge of the subchart to the desired location.
3 Double-click the subchart to open it.
The tip of the arrowhead of the supertransition appears highlighted in red, entering
the subchart.
7-14
Move Between Levels of Hierarchy Using Supertransitions
7-15
7 Techniques for Streamlining Chart Design
7-16
Move Between Levels of Hierarchy Using Supertransitions
1 Draw an inner transition segment from the source object anywhere just outside the
border of the subchart
7-17
7 Techniques for Streamlining Chart Design
2 Navigate up to the parent object by selecting View > Navigate > Up to Parent.
The tip of the arrowhead of the supertransition appears highlighted in red, exiting
the subchart.
7-18
Move Between Levels of Hierarchy Using Supertransitions
7-19
7 Techniques for Streamlining Chart Design
7-20
Move Between Levels of Hierarchy Using Supertransitions
Note: If the parent chart is itself a subchart and the terminating object resides at a
higher level in the subchart hierarchy, repeat these steps until you reach the desired
parent. In this way, you can connect objects separated by any number of layers in the
subchart hierarchy.
Label Supertransitions
A supertransition is displayed with multiple resulting transition segments for each layer
of containment traversed. For example, if you create a transition between a state outside
7-21
7 Techniques for Streamlining Chart Design
a subchart and a state inside a subchart of that subchart, you create a supertransition
with three segments, each displayed at a different containment level.
You can label any one of the transition segments constituting a supertransition using the
same procedure used to label a regular transition (see Label Transitions on page 4-19).
The resulting label appears on all the segments that constitute the supertransition. Also,
if you change the label on any one of the segments, the change appears on all segments.
7-22
Define a Graphical Function
2 Move your pointer to the location for the new graphical function in your chart and
click to insert the function box.
3 Enter the function signature.
The function signature specifies a name for your function and the formal names for
its arguments and return values. A signature has this syntax:
where func is the name of your function, a1, a2, ..., an are formal names for its
arguments, and r1, r2, ..., rn are formal names for its return values.
Note: You can define arguments and return values as scalars, vectors, or 2-D
matrices of any data type.
4 Click outside of the function box.
The following signature is for a graphical function that has the name f1, which takes
three arguments (a, b, and c) and returns three values (x, y, and z).
7-23
7 Techniques for Streamlining Chart Design
Note: In the chart, you can change the signature of your graphical function at any time.
After you edit the signature, the Model Explorer updates to reflect the changes.
2 Move your pointer inside the function box in your chart and click to insert the
default transition and its terminating junction.
3 Enter transition conditions and actions for your graphical function. If necessary, add
connective junctions and transitions to your function.
Note: Connective junctions and transitions are the only graphical elements you can
use in a graphical function. Because a graphical function must execute completely
when you call it, you cannot use states.
This function box shows a flow chart that returns different products of its arguments.
7-24
Define a Graphical Function
The Scope column in the Model Explorer indicates the role of each argument or
return value. Arguments have the scope Input, and return values have the scope
Output.
3 For each function argument and return value, right-click the data row in the Model
Explorer and select Properties from the context menu.
4 In the Data properties dialog box for each argument and return value, specify the
data properties.
Your function can access its own data or data belonging to parent states or the chart.
The data items that you create for the function itself can have one of these scopes:
Local
Local data persists from one function call to the next. Valid for C charts only.
Temporary
Temporary data initializes at the start of every function call. Valid for C charts
only. In charts that use MATLAB as the action language, you do not need to
7-25
7 Techniques for Streamlining Chart Design
define temporary function data in the Model Explorer. If a variable is used and
not previously defined, then it is automatically created. The variable is available
to the rest of the function.
Constant
Constant data retains its initial value through all function calls.
Note: You can initialize your function data (other than arguments and return
values) from the MATLAB workspace. However, you can save only local items to this
workspace.
7-26
Manage Large Graphical Functions
However, if your function grows too large, you can hide its contents by right-clicking
inside the function box and selecting Group & Subchart > Subchart from the context
menu. This option makes your graphical function opaque.
7-27
7 Techniques for Streamlining Chart Design
7-28
Call Graphical Functions in States and Transitions
Syntax
Syntax for a function call is the same as that of a function signature, with actual
arguments replacing the formal ones specified in a signature. If the data types of the
actual and formal argument differ, a function casts the actual argument to the type of
the formal argument. See Create a Graphical Function on page 7-23 for information
about syntax for a function signature.
Tip: If the formal arguments of a function signature are scalars, verify that inputs and
outputs of function calls follow the rules of scalar expansion. For more information, see
How Scalar Expansion Works for Functions on page 16-6.
Example
In this example, a state entry action calls a graphical function that returns three
products.
7-29
7 Techniques for Streamlining Chart Design
The fields in the General tab of the properties dialog box are:
Field Description
Name Click this read-only function name to bring your function to the
foreground in its native chart.
7-30
Specify Graphical Function Properties
Field Description
Function Inline Select one of these options to control the inlining of your
Option function in generated code:
Auto
Decides whether or not to inline your function based on an
internal calculation.
Inline
Inlines your function as long as you do not export it to other
charts, and it is not part of a recursion. (A recursion exists
if your function calls itself directly or indirectly through
another function call.)
Function
Does not inline your function.
Label Specify the signature label for your function in this field.
See Create a Graphical Function on page 7-23 for more
information.
The fields in the Documentation tab of the properties dialog box are:
Field Description
Description Enter a textual description or comment.
Document link Enter a URL address or a general MATLAB
command. Examples are www.mathworks.com,
mailto:email_address, and edit/spec/data/speed.txt.
7-31
7 Techniques for Streamlining Chart Design
Create modular, reusable logic that you can call anywhere in your chart.
Track simulation behavior visually during chart animation.
If you want to call the function only within one state or subchart and its substates,
put your graphical function in that state or subchart. That function overrides any
other functions of the same name in the parents and ancestors of that state or
subchart.
If you want to call the function anywhere in that chart, put your graphical function at
the chart level.
If you want to call the function from any chart in your model, put your graphical
function at the chart level and enable exporting of chart-level graphical functions. For
instructions, see Export Stateflow Functions for Reuse on page 7-34.
7-32
Reuse Logic Patterns Using Graphical Functions
7-33
7 Techniques for Streamlining Chart Design
In this section...
Why Export Chart-Level Functions? on page 7-34
How to Export Chart-Level Functions on page 7-34
Rules for Exporting Chart-Level Functions on page 7-35
Export Chart-Level Functions on page 7-35
Graphical
Truth table
MATLAB
When you select Export Chart Level Functions, you can call exported functions by
using Simulink Caller blocks with dot notation, chartName.functionName. To call the
exported functions throughout the model from any Stateflow or Simulink Caller block,
select Treat Exported Functions as Globally Visible. Do not use dot notation to call
these functions. You cannot export functions with the same name.
Simulink functions can also be defined directly in the Simulink canvas. For more
information, see Simulink Function.
7-34
Export Stateflow Functions for Reuse
You must perform this step to export functions from library charts. Otherwise, a
simulation error occurs.
You cannot export a chart-level function when inputs or outputs have any of the
following properties:
If you try to export Simulink functions, an error appears when you simulate your model.
To avoid this behavior, clear the Export Chart Level Functions check box in the Chart
properties dialog box.
You cannot export functions from a referenced model and call the functions from a parent
model.
7-35
7 Techniques for Streamlining Chart Design
In the Model Explorer, for each of the function inputs and outputs, a, b, and c, set
these properties:.
Size to 1
Complexity to Off
7-36
Export Stateflow Functions for Reuse
Type to double
3 For modChart, add a graphical function and a default transition with a lib1_func
action.
a In the Model Explorer, for each of the function inputs and outputs, a, b, and c,
set:
Size to 1
Complexity to Off
Type to double
b Open the Chart properties dialog box.
c In the Chart properties dialog box, select Export Chart Level Functions.
d Click OK.
5 Drag lib1Chart and lib2Chart into main_model from lib1 and lib2,
respectively. Your main model should look something like this:
Each chart now defines a graphical function that any chart in main_model can call.
7-37
7 Techniques for Streamlining Chart Design
This step ensures that input and output data are defined globally to support
exported graphical functions.
9 Open the Model Configuration Parameters dialog box.
10 In the Model Configuration Parameters dialog box, go to the Solver pane.
11 In the Solver options section, make these changes:
This step ensures that when you simulate your model, a discrete solver is used. For
more information, see Solvers (Simulink).
When you simulate the model, these actions take place during each time step.
7-38
Export Stateflow Functions for Reuse
To view the simulation results, add a scope to your model. Follow these steps:
{x = lib1_func(x,y); z = x;}
7 In the model, connect the outport from modChart to the inport of the Scope block.
7-39
7 Techniques for Streamlining Chart Design
7-40
Group Chart Objects Using Boxes
Boxes add a level of hierarchy to Stateflow charts. This property affects visibility of
functions and states inside a box to objects that reside outside of the box. If you refer to
a box-parented function or state from a location outside of the box, you must include the
box name in the path. See Group Functions Using a Box on page 7-44.
Boxes affect the implicit activation order of parallel states in a chart. If your chart uses
implicit ordering, parallel states within a box wake up before other parallel states that
are lower or to the right in that chart. Within a box, parallel states wake up in top-down,
left-right order. See Group States Using a Box on page 7-45.
7-41
7 Techniques for Streamlining Chart Design
Include the box name in the path when you use dot notation to refer to a box-parented
function or state from a location outside of the box.
You can move or draw graphical objects inside a box, such as functions and states.
You can add data to a box so that all the elements in the box can share the same data.
You can group a box and its contents into a single graphical element. See Group
States on page 4-6.
You can subchart a box to hide its elements. See Encapsulate Modal Logic Using
Subcharts on page 7-5.
You cannot define action statements for a box, such as entry, during, and exit
actions.
You cannot define a transition to or from a box. However, you can define a transition
to or from a state within a box.
You create boxes in your chart by using the box tool shown below.
7-42
Group Chart Objects Using Boxes
The new box appears with a question mark (?) name in its upper left corner.
4 Click the question mark label.
7-43
7 Techniques for Streamlining Chart Design
5 Enter a name for the box and then click outside of the box.
Delete a Box
This chart shows a box named Status that groups together MATLAB functions.
Note: Because the MATLAB function resides inside a box, the path of the function
call must include the box name Status. If you omit this prefix, an error message
appears.
3 If the value of the input data temp exceeds 80, a transition to the state Warm occurs.
4 Upon entry, the state Warm invokes the function Status.msgWarm.
7-44
Group Chart Objects Using Boxes
Note: Because the MATLAB function resides inside a box, the path of the function
call must include the box name Status. If you omit this prefix, an error message
appears.
5 If the value of the input data temp drops below 60, a transition to the state Cold
occurs.
6 Steps 2 through 5 repeat until the simulation ends.
This chart shows a box named Status that groups together related states. The chart
uses implicit ordering for parallel states, instead of the default explicit mode. (For
details, see Implicit Ordering of Parallel States on page 3-80.)
7-45
7 Techniques for Streamlining Chart Design
The state Temp wakes up first, followed by the state Wind_Chill. Then, the state
Monitor wakes up.
Note: This implicit activation order occurs because Temp and Wind_Chill reside in a
box. If you remove the box, the implicit activation order changes, as shown, to: Temp,
Monitor, Wind_Chill.
Based on the input data temp, transitions between substates occur in the parallel
states Status.Temp and Status.Wind_Chill.
When the transition from Status.Temp.Cold to Status.Temp.Warm occurs, the
transition condition in(Status.Temp.Warm) becomes true.
When the transition from Status.Temp.Warm to Status.Temp.Cold occurs, the
transition condition in(Status.Temp.Cold) becomes true.
7-46
Group Chart Objects Using Boxes
7-47
7 Techniques for Streamlining Chart Design
You can reuse an atomic box across multiple charts and models.
An atomic box cannot contain states, only functions (graphical, truth table, MATLAB,
and Simulink).
Use an atomic box to reuse functions in the same way that you use an atomic subchart
to reuse states. For more information about atomic subcharts, see What Is an Atomic
Subchart? on page 14-2.
Models that use these functions can appear as referenced blocks in a top model. However,
when the functions are exported functions of a Stateflow chart, you can use only one
instance of that referenced block per top model. For a complete list of model referencing
limitations, see Limitations on All Model Referencing (Simulink).
With atomic boxes, you can avoid the limitation due to exported functions. You can reuse
models with these functions multiple times as referenced blocks in a top model.
7-48
Reuse Functions with an Atomic Box
1 Create a library model with an atomic box that contains the function you want to
reuse.
2 Create a separate model with multiple charts.
a In each chart that calls the function, add a linked atomic box.
b Write each call to the function using the full path:
linked_box_name.function_name
Using the full path for the function call has the following advantages:
Makes clear the dependency on the function in the linked atomic box
Avoids pollution of the global namespace
Does not affect efficiency of the generated code
3 Reuse that model multiple times as referenced blocks in a top model.
Because there are no exported functions in the charts, you can use more than one
instance of that referenced block in the top model.
Note: For charts that use MATLAB as the action language, use the function
getSimulationTime().
7-49
7 Techniques for Streamlining Chart Design
The function GetTime returns one output tout that corresponds to simulation
time t. For more information about literal symbols you can use in your chart,
see Supported Symbols in Actions on page 11-27.
d Save libTimerUtils.
2 Develop a separate model with multiple charts that use the timer function.
7-50
Reuse Functions with an Atomic Box
To add the linked atomic box, copy the TimerUtils library chart and paste it
below state A. Name the linked atomic box as Time.
When you copy and paste a library chart that contains only functions and no
states, you get a linked atomic box. If the library chart contains any states, you
get a linked atomic subchart.
d In Chart1, add the following state action and transition condition:
Upon entry to state A, the call to GetTime returns the simulation time. The
transition from state A to B occurs when more than 5 seconds of simulation time
passes.
e In Chart2, add the following state action and transition condition:
7-51
7 Techniques for Streamlining Chart Design
Upon entry to state A, the call to GetTime returns the simulation time. The
transition from state A to B occurs when more than 7 seconds of simulation time
passes.
f In each chart, add local data with the following properties:
Property Value
Name t0
Scope Local
Type double
g In each chart, open the State properties dialog box for B and select Create data
for monitoring:. Click OK.
This step adds an output data named B that is Boolean. The value is 1 when
state B is active and 0 otherwise. For more information, see About Active State
Data on page 22-30.
h In your model, add two Outport blocks, Out1 and Out2. Then connect each block
to the corresponding output of each chart.
i Save ex_timer_function_calls.
3 Reuse the timer function in multiple referenced blocks of a top model.
7-52
Reuse Functions with an Atomic Box
d Save ex_modelref_utility_functions.
7-53
7 Techniques for Streamlining Chart Design
Create Notes
You can enter comments or notes in any location on the chart.
1 Double-click in the desired location of the chart and start typing your comments.
2 Press the Return key to start a new line.
3 After you finish typing, click outside the note text.
Borders
Text alignment and word wrap
Text color and background color
Margins between the text and the borders of the note
7-54
Add Descriptive Comments in a Chart
TeX Instructions
In your notes, you can embed a subset of TeX commands to produce special characters.
For example, you can embed Greek letters and mathematical symbols.
\it{\omega_N = e^{(-2\pii)/N}}
4 Click outside the note.
7-55
8
Define Data
Add data when you want to store values that are visible at a specific level of the
Stateflow hierarchy.
You can store and retrieve data that resides internally in the Stateflow workspace and
externally in the Simulink model or application that embeds the chart. Actions in your
chart can refer to internal and external data.
You can use data defined in a Stateflow chart by multiple Stateflow objects in the chart.
These objects can be states, transition, MATLAB functions, and truth tables. Stateflow
data is not available to Simulink functions within Stateflow.
To open the Symbols window, select View > Symbols. To add data in the Symbols
window:
1
Click the Create Data icon .
2 In the row for the new data, under TYPE, click the icon and choose:
Input Data
Local Data
Output Data
Constant
Data Store Memory
Parameter
Temporary
3 Edit the name of the data.
8-2
Add Stateflow Data
4 For input and output data, click the PORT field and choose a port number.
You can edit properties for data in the Property Inspector or Data properties dialog box.
The object you select becomes the parent of the new data.
3 In the Model Explorer, select Add > Data.
The Model Explorer adds a default definition for the data in the hierarchy. The data
definition appears in a new row in the Model Explorer.
4 Change the properties of the data.
More About
Set Data Properties on page 8-6
8-3
8 Define Data
Machine-parented data
Inputs and outputs of MATLAB functions
Data of parameter scope in a chart that contains atomic subcharts
More About
Trace Data, Events, and Messages with the Symbols Window on page 30-7
Unused data, events, messages, and functions (Simulink)
8-4
Detect Unused Data in the Symbols Window
8-5
8 Define Data
In this section...
Stateflow Data Properties on page 8-6
Set Properties in the Logging Section on page 8-19
Set Properties in the Description Pane on page 8-20
Enter Expressions and Parameters for Data Properties on page 8-20
You can specify data properties in either the Property Inspector or the Data properties
dialog box in the Model Explorer.
Property Inspector
Properties vary according to the scope and type of the data object. For many data
properties, you can enter expressions or parameter values. Using parameters to set
properties for many data objects simplifies maintenance of your model because you can
update multiple properties by changing a single parameter.
Name of the data object. For more information, see Rules for Naming Stateflow Objects
on page 2-4.
8-6
Set Data Properties
Scope
Location where data resides in memory, relative to its parent. You can set scope to one of
these values.
8-7
8 Define Data
Port
Index of the port associated with the data object. This property applies only to input and
output data. See Share Output Data with Simulink on page 8-23.
Option that specifies that output or local data explicitly inherits properties from
Simulink.Signal objects of the same name in the MATLAB base workspace or the
Simulink model workspace. The data can inherit these properties:
Size
Complexity
Type
Unit
Minimum value
Maximum value
Initial value
Storage class
Sampling mode (for Truth Table block output data)
For more information, see Resolve Data Properties from Simulink Signal Objects on
page 8-59.
This option appears only if you set the model configuration parameter Signal
resolution to a value other than None.
Size
Size of the data object. The size can be a scalar value or a MATLAB vector of values. To
specify a scalar, set the Size property to 1 or leave it blank. To specify a MATLAB vector
8-8
Set Data Properties
use a multidimensional array. The number of dimensions equals the length of the vector
and the size of each dimension corresponds to the value of each vector element.
The scope of the data object determines what sizes you can specify. Stateflow data store
memory inherits all its properties, including its size, from the Simulink data store
to which it is bound. For all other scopes, size can be scalar, vector, or a matrix of n-
dimensions.
Variable size
Option that specifies whether the data object changes dimensions during simulation.
When you enable the chart property Support variable-size arrays, this option is
available only for input and output data. For more information, see Variable-Size Data.
Complexity
Option that specifies whether the data object accepts complex values. You can choose one
of these settings.
For more information, see How Complex Data Works in C Charts on page 21-2.
Type
Assistant, click the Show data type assistant button . The Data Type
Assistant is available only in the Data properties dialog box. It is not available in the
Symbols window.
8-9
8 Define Data
Note: If you enter an expression for a fixed-point data type, you must specify
scaling explicitly. For example, you cannot enter an incomplete specification such
as fixdt(1,16) in the Type field. If you do not specify scaling explicitly, an error
appears when you try to simulate your model.
To ensure that a data type definition is valid for fixed-point data, use one of the two
options.
Prevents replacement of the current fixed-point type with a type that the Fixed-Point
Tool (Fixed-Point Designer) or Fixed-Point Advisor (Fixed-Point Designer) chooses.
For methods on autoscaling fixed-point data, see Choosing a Range Collection Method
(Fixed-Point Designer).
For input and output data, you can specify physical units. See Units in Stateflow on
page 22-43.
Initial value
Initial value of the data object. If you do not specify a value, the default is 0.0. The
options for initializing values depend on the scope of the data object.
8-10
Set Data Properties
For more information, see Initialize Data from the MATLAB Base Workspace on page
8-25 and Share Simulink Parameters with Charts on page 8-24.
Range of acceptable values for this data object. Stateflow software uses this range
to validate the data object during simulation. To establish the range, specify these
properties:
Minimum The smallest value allowed for the data item during simulation. You
can enter an expression or parameter that evaluates to a numeric scalar value.
Maximum The largest value allowed for the data item during simulation. You can
enter an expression or parameter that evaluates to a numeric scalar value.
The smallest value you can set for Minimum is -inf. The largest value you can set for
Maximum is inf.
Note: A Simulink model uses the Limit range properties to calculate best-precision
scaling for fixed-point data types. Specify a minimum or maximum value before you
select Calculate Best-Precision Scaling in the General pane. For more information,
see Calculate Best-Precision Scaling on page 8-14.
For more information on entering values for Limit range properties, see Enter
Expressions and Parameters for Data Properties on page 8-20.
Option for watching the data values in the Stateflow Breakpoints and Watch window (see
Watch Stateflow Data Values on page 29-35).
Properties that apply to fixed-point data. These fixed-point properties are available only
in the Data properties dialog box.
8-11
8 Define Data
When the Data Type Assistant Mode is Fixed point the Data Type Assistant displays
fields for specifying additional information about your fixed-point data.
If the Scaling is Slope and bias rather than Binary point, the Data Type Assistant
displays a Slope field and a Bias field rather than a Fraction length field.
8-12
Set Data Properties
You can use the Data Type Assistant to set these fixed-point properties:
Signedness
Specify whether you want the fixed-point data to be Signed or Unsigned. Signed data
can represent positive and negative values, but unsigned data represents positive values
only. The default setting is Signed.
Word length
Specify the bit size of the word that holds the quantized integer. Large word sizes
represent large values with greater precision than small word sizes. The default bit size
is 16.
For chart-level data of the following scopes, word length can be any integer from 0
through 128.
Input
Output
Parameter
Data Store Memory
For other Stateflow data, word length can be any integer from 0 through 32.
Scaling
Specify the method for scaling your fixed-point data to avoid overflow conditions and
minimize quantization errors. The default method is Binary point scaling. You can
select one of two scaling modes.
8-13
8 Define Data
Slope can be any positive real number. The default slope is 1.0. Bias
can be any real number. The default bias is 0.0. You can enter slope and
bias as expressions that contain parameters you define in the MATLAB
workspace.
For more information about fixed-point scaling, see Scaling (Fixed-Point Designer).
Specify whether to inherit the data type override setting of the Fixed-Point Tool that
applies to this model. If the data does not inherit the model-wide setting, the specified
data type applies. For more information about the Fixed-Point Tool, see fxptdlg.
Calculate best-precision values for Binary point and Slope and bias scaling,
based on the Limit range properties that you specify in the General tab of the Data
properties dialog box.
8-14
Set Data Properties
Simulink software calculates the scaling values and displays them in the Fraction
length field or the Slope and Bias fields. For more information, see Constant Scaling
for Best Precision (Fixed-Point Designer).
Note: The Limit range properties do not apply to Constant and Parameter scopes. For
Constant, Simulink software calculates the scaling values based on the Initial value
setting. The software cannot calculate best-precision scaling for data of Parameter
scope.
Option in the Data properties dialog box when you specify a fixed-point data type. To see
information about the fixed-point data type that is defined in the Data Type Assistant,
use the Fixed-point details section. Click the expander next to Fixed-point details in
the Data Type Assistant.
8-15
8 Define Data
8-16
Set Data Properties
The rows labeled Minimum and Maximum show the same values that appear in the
corresponding Minimum and Maximum fields in the Limit range section. See Signal
Ranges (Simulink) and Specify Minimum and Maximum Values for Block Parameters
(Simulink).
The values displayed by the Fixed-point details subpane do not automatically update
if you click Calculate Best-Precision Scaling, or change the range limits, the values
that define the fixed-point data type, or anything elsewhere in the model. To update the
values shown in the Fixed-point details subpane, click Refresh Details. The Data
Type Assistant then updates or recalculates all values and displays the results.
Clicking Refresh Details does not change anything in the model; it changes only the
display. Click OK or Apply to put the displayed values into effect. If the value of a
field cannot be known without first compiling the model, the Fixed-point details
subpane shows the value as Unknown. If errors occur when you click Refresh Details,
the subpane shows an error flag on the left of the applicable row and a description of the
error on the right. For example, the next figure shows two errors.
8-17
8 Define Data
The row labeled Minimum shows the error Cannot evaluate because evaluating the
expression MySymbol, specified in the Minimum field of the Limit range section,
cannot return a numeric value. When an expression does not evaluate successfully,
the Fixed-point details subpane shows the unevaluated expression (truncating to 10
characters as needed) in place of the unavailable value.
8-18
Set Data Properties
To correct this error, define MySymbol in the base workspace to provide a numeric value.
If you click Refresh Details, the value of MySymbol appears in place of the unevaluated
text. The error indicator and description are deleted.
To correct the overflow error for Maximum, change the fixed-point data type so that it can
represent the maximum value you specify.
Decrease the value in the Maximum field of the Limit range section.
Increase Word length.
Decrease Fraction length.
Test point
Designates the data as a test point. A test point is a signal that you can observe in a
Floating Scope block in a model (see Test Points (Simulink)). Data objects can be test
points if:
Scope is Local.
Parent is not a Stateflow machine.
Data type is not ml.
Logging name
Specifies the name associated with logged signal data. Simulink software uses the signal
name as its logging name by default. To specify a custom logging name, select Custom
from the list box and enter the new name in the adjacent edit field.
Decimation
Limits the amount of data logged by skipping samples. For example, a decimation factor
of 2 saves every other sample.
8-19
8 Define Data
Option that assigns the value of the data item to a variable of the same name in the base
workspace at the end of simulation (see Model Workspaces (Simulink)).
First index
Index of the first element of the data array. The default value is 0.
Units
Units of measurement that you want to associate with the data object. The unit in this
field resides with the data object in the Stateflow hierarchy.
Description
Document link
Link to online documentation for the data object. You can enter a web URL address or a
MATLAB command that displays documentation in a suitable online format, such as an
HTML file or text in the MATLAB Command Window. When you click the Document
link hyperlink at the bottom of the properties dialog box, Stateflow software evaluates
the link and displays the documentation.
8-20
Set Data Properties
Expressions can contain a mix of parameters, constants, arithmetic operators, and calls
to MATLAB functions.
When you leave an expression or parameter field blank, Stateflow software assumes a
default value.
Field Default
Initial value 0.0
Maximum inf
Minimum inf
Word length 16
Slope 1.0
Bias 0.0
Binary point 0
First index 0
Size -1 (inherited), for inputs, parameters, and function outputs
1 (scalar), for other data objects
You can include parameters in expressions. A parameter is a constant that you can:
Define in the MATLAB workspace (see Initialize Data from the MATLAB Base
Workspace on page 8-25)
Derive from a Simulink block parameter that you define and initialize in the parent
masked subsystem (see Share Simulink Parameters with Charts on page 8-24)
For expressions in the Data properties dialog box, you can use numeric constants of the
appropriate type and size. Do not use Stateflow constants in these expressions.
8-21
8 Define Data
In the Data properties dialog box, you can use these arithmetic operators in expressions.
+
*
/
In fields that accept expressions, you can call functions that return property values of
other variables defined in the Stateflow hierarchy, MATLAB workspace, or Simulink
masked subsystem. For example, these functions can return appropriate values for
specified fields in the Data properties dialog box.
More About
Type Stateflow Data on page 8-36
Size Stateflow Data on page 8-44
Identify Data Using Dot Notation on page 8-54
Best Practices for Using Data in Charts on page 8-63
8-22
Share Data with Simulink and MATLAB Workspace
1 Add a data object to the chart, as described in Add Data from the Stateflow Editor
on page 8-2.
Note: Add the data to the chart itself, not to any other object in the chart.
2 In the Symbols window, set the TYPE to Input Data.
You can change port assignments by editing the value in the PORT field.
3 Set the data type of the input data, as described in Type Stateflow Data on page
8-36.
4 Set the size of the input data, as described in Size Stateflow Data on page 8-44.
Note: You cannot type or size Stateflow input data to accept frame-based data from
Simulink.
8-23
8 Define Data
1 Add a data object to the chart, as described in Add Data from the Stateflow Editor
on page 8-2.
Note: Add data to the chart itself, not to any other object in the chart.
2 In the Symbols window, set the TYPE property to Output Data.
You assign outputs to ports in the order in which you add the data. For example, you
assign the third output to output port 3. You can change port assignments by editing
the value in the PORT field.
3 Set the type of the output data, as described in Type Stateflow Data on page
8-36.
4 Set the size of the output data, as described in Size Stateflow Data on page
8-44.
Share Simulink parameters with charts to maintain consistency with your Simulink
model. By using parameters, you can also avoid hard-coding data sizes and types.
You can use parameters defined in a Stateflow chart in multiple Stateflow objects in the
chart, such as states, MATLAB functions and truth tables.
To share Simulink parameters for a masked subsystem with a chart, follow these steps:
1 In the Simulink mask editor for the parent subsystem, define and initialize a
Simulink parameter.
2 In the Stateflow hierarchy, define a data object with the same name as the
parameter (see Add Stateflow Data on page 8-2).
3 Set the scope of the data object to Parameter.
8-24
Share Data with Simulink and MATLAB Workspace
When simulation starts, Simulink tries to resolve the Stateflow data object to a
parameter at the lowest level masked subsystem. If unsuccessful, Simulink moves up
the model hierarchy to resolve the data object to a parameter at higher level masked
subsystems.
When simulation starts, data resolution occurs. During this process, the Stateflow data
object gets its initial value from the associated MATLAB variable. For example, if the
variable is an array, each element of the Stateflow array initializes to the same value as
the corresponding element of the MATLAB array.
One-dimensional Stateflow arrays are compatible with MATLAB row and column vectors
of the same size. For example, a Stateflow vector of size 5 is compatible with a MATLAB
row vector of size [1,5] or column vector of size [5,1].
Time of Initialization
Data parent and scope control initialization time for Stateflow data objects.
8-25
8 Define Data
In the Description pane of the Data properties dialog box, select Save final value
to base workspace.
In the Contents pane of the Model Explorer, follow these steps:
8-26
About Data Stores
You can use data stores with buses, but not with arrays of buses. For more information
about using data stores with buses, see "Using Data Stores with Buses and Arrays of
Buses" (Simulink).
8-27
8 Define Data
Global data stores have a broader scope, which crosses model reference boundaries. To
interact with global data stores, a chart must reside either in the top model where
the global data store is defined or in any model that the top model references. You
implement global data stores as Simulink signal objects.
8-28
Access Data Store Memory from a Chart
Note: You cannot edit properties that the data object inherits from the data store.
1 Select Chart > Add Other Elements > Data Store Memory.
The properties dialog box for the new data object appears with scope property set to
Data Store Memory.
2 In the Name field of the Data properties dialog box, enter the name of the Simulink
data store to which you want to bind.
3 Click OK.
8-29
8 Define Data
The following chart reads from and writes to a data store memory block called myglobal.
8-30
Access Data Store Memory from a Chart
8-31
8 Define Data
Note: These diagnostics are available only for data store memory blocks used within a
single Simulink model, not for data stores created from Simulink signal objects. In other
words, these diagnostics do not work for global data stores that cross model reference
boundaries.
1 Double-click the data store memory block in your Simulink model to open its Block
Parameters dialog box.
8-32
Diagnostics for Sharing Data Between Charts and Simulink Blocks
8-33
8 Define Data
1 Define data store memory objects that reside in each chart that shares the data.
a Use the Model Explorer to add a data object to each chart, as described in Add
Data Through the Model Explorer on page 8-3.
b Give each data object the same name.
c Set the scope of each data object to Data Store Memory.
2 Verify that your models do not contain any Data Store Memory blocks.
However, you can include Data Store Read and Data Store Write blocks.
3 Create a Simulink.Signal object in the MATLAB base workspace.
a In the Model Explorer, navigate to Simulink Root > Base Workspace in the
Model Hierarchy pane.
b Select Add > Simulink Signal.
c Give the object the same name as the data store memory objects in your charts.
4 Verify that these settings apply to the Simulink.Signal object:
8-34
Best Practices for Using Data Stores in Charts
For instructions on how to set block execution order, see Control and Display the
Sorted Order (Simulink).
8-35
8 Define Data
In this section...
What Is Data Type? on page 8-36
Specify Data Type with the Property Inspector on page 8-36
Specify Data Type with the Data Type Assistant on page 8-36
Built-In Data Types on page 8-39
Inherit Data Types from Simulink Objects on page 8-40
Derive Data Types from Previously Defined Data on page 8-40
Type Data by Using an Alias on page 8-41
Strong Data Typing with Simulink I/O on page 8-42
1 Open the Symbols and Property Inspector windows from the View menu.
2 Select the data object row in the Symbols window.
3 In the Property Inspector, enter the data type directly in the Type field, or select it
from the Type drop-down list.
8-36
Type Stateflow Data
3 Choose a Mode in the Data Type Assistant section of the dialog box.
For charts that use MATLAB as the action language, if scope is Local, you
infer the data type from the context of the MATLAB code in the chart.
If scope is Input, you inherit the data type from the Simulink input signal on
the designated input port (see Share Output Data with Simulink on page
8-23).
If scope is Output, you inherit the data type from the Simulink output signal
on the designated output port (see Share Output Data with Simulink on
page 8-23).
Note: Avoid inheriting data types from output signals. See Avoid inheriting
output data properties from Simulink blocks on page 8-63.
8-37
8 Define Data
For information on how to specify these fixed-point data properties, see Fixed-
Point Data Properties on page 8-11.
Enumerated Specify the class name for the enumerated data type. For more information, see
Define Enumerated Data in a Chart on page 18-8.
Expression Enter an expression that evaluates to a data type in the Type field. You can use
these expressions:
For more information on how to build expressions in the Data properties dialog
box, see Enter Expressions and Parameters for Data Properties on page 8-20.
8-38
Type Stateflow Data
Note: You can also inherit bus object properties from Simulink signals.
5 Click Apply to save the data type settings.
Note: The Data Type Assistant is available only with the Data properties dialog box. It is
not available with the Symbols window.
8-39
8 Define Data
Note: Avoid inheriting data types from output signals. See Avoid
inheriting output data properties from Simulink blocks on page
8-63.
Parameter Corresponding MATLAB workspace variable or Simulink
parameter in a masked subsystem
Data Store Memory Corresponding Simulink data store
To configure these objects to inherit data types, create the corresponding objects in the
Simulink model, and then select Inherit: Same as Simulink from the Type drop-
down list in the Data properties dialog box. For more information, see Specify Data Type
with the Data Type Assistant on page 8-36.
To determine the data types that the objects inherit, build the Simulink model and look
at the Compiled Type column for each Stateflow data object in the Model Explorer.
8-40
Type Stateflow Data
After you build your model, the Compiled Type column of the Model Explorer shows the
type of each data object in the compiled simulation application. For more information, see
type Operator on page 11-25.
MyFloat = Simulink.AliasType;
MyFloat.BaseType = 'single';
In the following example, the data y has the same type as MyFloat.
8-41
8 Define Data
After you build your model, the Compiled Type column of the Model Explorer shows the
type used in the compiled simulation application.
By default, inputs to and outputs from charts are of type double. Input signals from
Simulink models convert to the type of the corresponding input data objects in charts.
Likewise, the data output objects convert to double before they are exported as output
signals to Simulink models.
To interface directly with signals of data types other than double without the need for
conversion, select Use Strong Data Typing with Simulink I/O in the chart properties.
The chart accepts input signals of any data type that Simulink supports, as long as the
data type of the input signal matches the type of the corresponding Stateflow data object.
Otherwise, you receive a type mismatch error.
Note: For fixed-point data, select Use Strong Data Typing with Simulink I/O to flag
mismatches between input or output fixed-point data in charts and their counterparts in
Simulink models.
8-42
Type Stateflow Data
More About
Specify Chart Properties on page 22-3
About Data Types in Simulink (Simulink)
8-43
8 Define Data
Stateflow data store memory inherits all data properties, including size, from the
Simulink data store to which it resolves. You cannot specify any properties explicitly for
data store memory.
8-44
Size Stateflow Data
The equivalent API command for specifying an inherited data size is:
data_handle.Props.Array.Size = '-1';
Chart actions that store values in the specified output infer the inherited size of output
data. If the expected size in the Simulink signal matches the inferred size, inheritance is
successful. Otherwise, a mismatch occurs during build time.
Note: Charts cannot inherit frame-based data sizes from Simulink signals.
8-45
8 Define Data
One-dimensional Stateflow vectors are compatible with Simulink row or column vectors
of the same size. For example, Stateflow input or output data of size 3 is compatible with
a Simulink row vector of size [1 3] or column vector of size [3 1].
8-46
Size Stateflow Data
1 Mask parameters
2 Model workspace
3 MATLAB base workspace
4 Stateflow data
For example, if a variable named off exists in the MATLAB base workspace and as local
chart data, do not use off in the Size field of the data properties.
8-47
8 Define Data
More About
Stateflow Data Properties on page 8-6
8-48
Handle Integer Overflow for Chart Data
In this section...
When Integer Overflow Can Occur on page 8-49
Support for Handling Integer Overflow in Charts on page 8-49
Effect of Integer Promotion Rules on Saturation on page 8-51
Impact of Saturation on Error Checks on page 8-52
For more information about saturation and wrapping for integer overflow, see
Saturation and Wrapping (Fixed-Point Designer).
8-49
8 Define Data
Check Box When to Use This Setting Overflow Handling Example of the Result
Selected Overflow is possible Overflows saturate to An overflow associated
for data in your chart either the minimum or with a signed 8-bit integer
and you want explicit maximum value that the saturates to 128 or +127
saturation protection in data type can represent. in the generated code.
the generated code.
Cleared You want to optimize The handling of overflows The number 130 does not
efficiency of the generated depends on the C fit in a signed 8-bit integer
code. compiler that you use for and wraps to 126 in the
generating code. generated code.
Arithmetic operations for which you can enable saturation protection are:
Unary minus: a
8-50
Handle Integer Overflow for Chart Data
Binary operations: a + b, a b, a * b, a / b, a ^ b
Assignment operations: a += b, a =b, a *= b, a /= b
In C charts, increment and decrement operations: ++, --
Keep the following considerations in mind when you select Saturate on integer
overflow:
Saturation applies to all intermediate operations, not just the output or final result.
The code generator can detect cases when overflow is not possible. In these cases, the
generated code does not include saturation protection.
All arithmetic operations use a data type that has the same word length as the target
word size. Therefore, the intermediate data type in a chained arithmetic operation
can be different from the data type of the operands or the final result.
For operands with integer types smaller than the target word size, promotion to a
larger type of the same word length as the target size occurs. This implicit cast occurs
before any arithmetic operations take place.
For example, when the target word size is 32 bits, an implicit cast to int32 occurs
for operands with a type of uint8, uint16, int8, or int16 before any arithmetic
operations occur.
Suppose that you have the following expression, where y, u1, u2, and u3 are of uint8
type:
y = (u1 + u2) - u3;
For each calculation, the following data types and saturation limits apply.
8-51
8 Define Data
Suppose that u1, u2, and u3 are equal to 200. Because the saturation limits depend on
the intermediate data types and not the operand types, you get the following values:
tmp is 400.
result is 200.
y is 200.
8-52
Define Temporary Data
You can define temporary data in graphical, truth table, and MATLAB functions in your
chart. For example, you can designate a loop counter to have Temporary scope if the
counter value does not need to persist after the function completes.
The Model Explorer adds a default definition for the data in the Stateflow hierarchy,
with a scope set to Temporary by default.
4 Change other properties of the data if necessary, as described in Set Data
Properties on page 8-6.
8-53
8 Define Data
For example, you can specify qualified data names in state actions and transitions by
using dot notation.
In this chart, data resides in the state aa. The qualified data names in state actions and
transitions use dot notation to refer to this data.
In state a, the entry action contains the qualified data name aa.data.
In state b, the entry action contains the qualified data name a.aa.data.
In the default transition, the action contains the qualified data name a.aa.data.
8-54
Identify Data Using Dot Notation
Display an
error
message.
8-55
8 Define Data
Stage Action
1 The search begins at the level of the hierarchy where the qualified data name
appears.
If a unique match exists, the statement containing the qualified data name
executes.
If no matches or multiple matches exist, an error message appears.
8-56
Identify Data Using Dot Notation
Suppose that state aa contains data. In state b, the entry action contains aa.data, a
qualified data name that the chart cannot resolve. The following search process occurs:
The search ends, and an error message appears because no match exists for aa.data.
To avoid this error, use a specific path for the qualified data name in the entry action of
state b:
en: a.aa.data+=1;
8-57
8 Define Data
Suppose that both states named aa contain a data object named data. In state a, the
entry action contains two instances of aa.data that the chart cannot resolve. The
following search process occurs:
The search ends, and an error message appears because multiple matches exist for
aa.data.
8-58
Resolve Data Properties from Simulink Signal Objects
In this section...
About Explicit Signal Resolution on page 8-59
Inherited Properties on page 8-59
Enable Signal Resolution on page 8-60
A Simple Example on page 8-60
For information about Simulink signal resolution, see Symbol Resolution (Simulink)
and Symbol Resolution Process (Simulink) in the Simulink documentation.
Inherited Properties
When Stateflow local or output data resolve to Simulink signal objects, they inherit these
properties:
Size
Complexity
Type
Minimum value
Maximum value
Initial value
Storage class
Storage class controls the appearance of chart data in the generated code. See
Control Data Representation by Applying Custom Storage Classes (Embedded
Coder).
8-59
8 Define Data
1 Set Configuration Parameters > Diagnostics > Data Validity > Signal
resolution to a value other than None. For more information about the other
options, see Signal resolution (Simulink).
2 In the model workspace, base workspace, or data dictionary, define a
Simulink.Signal object with the properties you want your Stateflow data to
inherit.
After you select this check box, the dialog box removes or grays out the properties
that your data inherits from the signal. For a list of properties that your data can
inherit during signal resolution, see Inherited Properties on page 8-59.
A Simple Example
The following model shows how a chart resolves local and output data to
Simulink.Signal objects.
8-60
Resolve Data Properties from Simulink Signal Objects
In the base workspace, there are three Simulink.Signal objects with these properties:
The chart contains three data objects two outputs and a local variable that will
resolve to a signal with the same name, as follows:
When you build the model, each data object inherits the properties of the identically
named signal:
8-61
8 Define Data
The generated code declares the data based on the storage class that the data inherits
from the associated Simulink signal. For example, the header file below declares local
to be an exported global variable:
/*
* Exported States
*
* Note: Exported states are block states with an exported
* global storage class designation.
*
*/
extern real32_T local; /* '<Root>/Chart' */
8-62
Best Practices for Using Data in Charts
Enumerated data
Simulink functions
Chart SimState
Implicit change events
Detection of unused data
Model referencing (see Limitations on All Model Referencing (Simulink))
Analysis by Simulink Design Verifier software
Code generation by Simulink PLC Coder software
Parameters binding to a Simulink.Parameter object in the base workspace
To make Stateflow data accessible to other charts and blocks in a model, use data store
memory. For details, see Access Data Store Memory from a Chart on page 8-29.
More About
Simulink Functions in Stateflow on page 27-2
What Is Enumerated Data? on page 18-2
8-63
8 Define Data
8-64
Transfer Data Across Models
1 In the Contents pane of the Model Explorer, rightclick the data object you want to
copy and select Copy from the context menu.
2 In the Model Hierarchy pane, right-click the destination Stateflow machine and
select Paste from the context menu.
8-65
9
Define Events
What Is an Event?
An event is a Stateflow object that can trigger actions in one of these objects:
Activate a Simulink triggered subsystem (see Activate a Simulink Block Using Edge
Triggers on page 9-20)
Activate a Simulink function-call subsystem (see Activate a Simulink Block Using
Function Calls on page 9-28)
Trigger actions in parallel states of a Stateflow chart (see Broadcast Events to
Synchronize States on page 11-52)
Although Stateflow software does not limit the number of events you can use in a
chart, the underlying C compiler enforces a theoretical limit of (2^31)-1 events for the
generated code.
9-2
How Events Work in Stateflow Charts
For more information about using conditions on transitions, see Transition Action
Types on page 11-8.
Types of Events
An explicit event is an event that you define and can have one of the following scopes.
Scope Description
Local Event that can occur anywhere in a Stateflow machine but is
visible only in the parent object (and descendants of the parent).
See Directed Event Broadcasting on page 11-52.
Input from Simulink Event that occurs in a Simulink block but is broadcast to a
Stateflow chart. See Activate a Stateflow Chart Using Input
Events on page 9-9.
Output to Simulink Event that occurs in a Stateflow chart but is broadcast to a
Simulink block. See Activate a Simulink Block Using Output
Events on page 9-20.
An implicit event is a built-in event that broadcasts automatically during chart execution
(see Control Chart Execution Using Implicit Events on page 9-33).
9-3
9 Define Events
simulation, you can reduce the size of your model. This diagnostic checks for usage of
Stateflow events, except for the following types:
After you select an event for removal, a dialog box confirms your choice. In this dialog
box, you can specify that other deletions occur without confirmation. If you prevent the
confirmation dialog box from appearing, you can reenable it at any time by typing at the
command prompt:
sfpref('showDeleteUnusedConfGui', 1)
You can control the level of diagnostic action for unused events in the Diagnostics
> Stateflow pane of the Model Configuration Parameters dialog box. For more
information, see the documentation for the Unused data, events, messages, and
functions (Simulink) diagnostic.
9-4
Define Events
Define Events
In this section...
Add Events with the Stateflow Editor on page 9-5
Add Events with the Model Explorer on page 9-5
To open the Symbols window, select View > Symbols. To add events in the Symbols
window:
1
Click the Create Event icon .
2 In the row for the new event, under TYPE, click the icon and choose:
Input Event
Local Event
Output Event
3 Edit the name of the event.
4 For input and output event, click the PORT field and choose a port number.
Specify properties for the new event as described in Set Properties for an Event on page
9-7.
9-5
9 Define Events
2 In the Model Explorer, on the Model Hierarchy pane, select the object in the
Stateflow hierarchy where you want the new event to be visible.
The Model Explorer adds a default definition for the new event in the hierarchy and
displays an entry row for the new event in the Contents pane.
4 Change the properties of the event that you add in one of these ways:
Right-click the event row and select Properties to open the Event properties
dialog box.
To set specific properties such as Name, Scope, and Port, click individual cells
in the entry row.
More About
Set Properties for an Event on page 9-7
How Events Work in Stateflow Charts on page 9-2
9-6
Set Properties for an Event
Property Inspector
Property Fields
Name
Name of the event. Actions reference events by their names. Names must begin with an
alphabetic character, cannot include spaces, and cannot be shared by sibling events.
Scope
Scope of the event. The scope specifies where the event occurs relative to the parent
object. For information about types of scope, see Types of Events on page 9-3.
Port
For input events, port is the index of the input signal that triggers the event.
9-7
9 Define Events
For output events, port is the index of the signal that outputs this event.
You assign input and output events to ports in the order in which you add the events. For
example, you assign the first input event to input port 1 and the third output event to
output port 3.
You can change port assignments in the Model Explorer or the Event properties dialog
box. When you change the number of one port, the numbers of other ports adjust
automatically to preserve the relative order. See Association of Input Events with
Control Signals on page 9-11 and Association of Output Events with Output Ports
on page 9-31.
Trigger
Type of signal that triggers an input or output event. See Activate a Stateflow Chart
Using Input Events on page 9-9 or Activate a Simulink Block Using Output
Events on page 9-20.
Debugger Breakpoints
Option for setting debugger breakpoints at the start or end of an event broadcast.
Available breakpoints depend on the scope of the event.
Description
Description of this event. You can enter brief descriptions of events in the hierarchy.
Document Link
9-8
Activate a Stateflow Chart Using Input Events
You can activate a Stateflow chart via a change in control signal (an edge-triggered input
event) or a function call from a Simulink block (a function-call input event). The sections
that follow describe when and how to use each type of input event.
Note: You cannot mix edge-triggered and function-call input events in a Stateflow chart.
If you try to mix these input events, an error message appears during simulation.
Use an edge-triggered input event to activate a chart when your model requires chart
execution at regular (or periodic) intervals.
1 Add an event to the Stateflow chart, as described in Define Events on page 9-5.
9-9
9 Define Events
Note: You must add an input event to the chart and not to one of its objects.
2 Set the Scope property for the event to Input from Simulink.
A single trigger port appears at the top of the Stateflow block in the Simulink model.
3 Set the Trigger property to one of these edge triggers.
In all cases, the signal must cross 0 to be a valid edge trigger. For example, a signal
that changes from -1 to 1 is a valid rising edge, but a signal that changes from 1to2
is not valid.
Note: When you use this type of input event, you must also define a function-call output
event for the block that calls the Stateflow chart.
Use a function-call input event to activate a chart when your model requires access to
output data from the chart in the same time step as the function call.
9-10
Activate a Stateflow Chart Using Input Events
1 Add an event to the Stateflow chart, as described in Define Events on page 9-5.
Note: You must add an input event to the chart and not to one of its objects.
2 Set the Scope property for the event to Input from Simulink.
A single trigger port appears at the top of the Stateflow block in the Simulink model.
3 Set the Trigger property to Function call.
The number of the port that you assign to the input event acts as an index into the
control signal vector. For example, the first element of the signal vector triggers the
input event assigned to input port 1, the fourth element triggers the input event assigned
to input port 4, and so on. You assign port numbers in the order in which you add the
events. However, you can change these assignments by setting the Port property of an
event to the index of the signal that you use to trigger the event.
For multiple input events to a trigger port, the data types of all signals must be identical.
If you use signals of different data types as input events, an error message appears when
you try to simulate your model.
For example, you can mux two input signals of type double to use as input events to a
chart.
9-11
9 Define Events
However, you cannot mux two input signals of different data types, such as boolean and
double.
At any given time step, input events are checked in ascending order based on their port
numbers. The chart awakens once per valid event. For edge-triggered input events,
multiple edges can occur in the same time step, which wake the chart more than once in
that time step. In this situation, events occur (and wake the chart) in an ascending order
based on their port numbers.
For function-call input events, only one trigger event exists. The caller of the event
explicitly calls and executes the chart. Only one function call can be valid in a single time
step.
9-12
Control States When Function-Call Inputs Reenable Charts
In this section...
Set Behavior for a Reenabled Chart on page 9-13
Behavior When the Parent Is the Model Root on page 9-13
Behavior When the Chart Is Inside a Model Block on page 9-17
9-13
9 Define Events
In the following model, the Caller chart uses the event E to wake up and execute the
Callee chart.
Each time the Callee chart executes, the output data y increments by one.
9-14
Control States When Function-Call Inputs Reenable Charts
In the Chart properties dialog box for Callee, States When Enabling is Inherit.
Because the parent of this chart is the model root, the chart maintains the most recent
values of all states when reenabled.
During simulation, Callee maintains the most recent value of its state when the
function-call input event reenables the chart at t = 20 and 40.
9-15
9 Define Events
Suppose that the States When Enabling property is Reset for Callee. During
simulation, Callee reverts to the initial value of its state when the function-call input
event reenables the chart at t = 20 and 40.
9-16
Control States When Function-Call Inputs Reenable Charts
The following model contains a Model block and a scope. (For more information about
using Model blocks, see For more information, see Model Reference (Simulink)..)
The Model block contains the Caller and Callee charts from Behavior When the
Parent Is the Model Root on page 9-13.
In the Chart properties dialog box for Callee, States When Enabling is Inherit.
Because this chart is inside a Model block, the chart reverts to the initial values of all
states when reenabled.
9-17
9 Define Events
During simulation, Callee reverts to the initial value of its state when the function-call
input event reenables the chart at t = 20 and 40.
9-18
Control States When Function-Call Inputs Reenable Charts
Suppose that the States When Enabling property is Held for Callee. During
simulation, Callee maintains the most recent value of its state when the function-call
input event reenables the chart at t = 20 and 40.
9-19
9 Define Events
You use output events to activate other blocks in the same model. You can define
multiple output events in a chart, where each output event maps to an output port (see
Port on page 9-7).
Use an edge-triggered output event to activate a Simulink subsystem when your model
requires subsystem execution at regular (or periodic) intervals.
1 Add an event to the Stateflow chart, as described in Define Events on page 9-5.
9-20
Activate a Simulink Block Using Output Events
For each output event you define, an output port appears on the Stateflow block.
3 Set the Trigger property of the output event to Either Edge.
Note: Unlike edge-triggered input events, you cannot specify a Rising or Falling
edge trigger.
The following model shows how to use an edge-triggered output event to activate
triggered subsystems at regular intervals.
The chart contains the edge-triggered output event e1 and the local data a, which
switches between 0 and 1 during simulation.
9-21
9 Define Events
When you simulate the model, the scope shows these results.
If a chart tries to broadcast the same edge-triggered output event multiple times in a
single time step, the chart dispatches only one of these broadcasts in the present time
step. However, the chart queues up any pending broadcasts for dispatch that is, one at
9-22
Activate a Simulink Block Using Output Events
a time in successive time steps. Each time the chart wakes up in successive time steps,
if any pending broadcasts exist for the output event, the chart signals the edge-triggered
subsystem for execution. Based on the block sorted order of the Simulink model, the
edge-triggered subsystem executes. (For details, see Control and Display the Sorted
Order (Simulink).)
Note: For information on what happens for function-call output events, see Interleaving
Behavior for Broadcasting a Function-Call Output Event Multiple Times on page
9-29.
In this model, the chart Caller uses the edge-triggered output event output_cmd to
activate the chart Callee.
The chart Caller tries to broadcast the same edge-triggered output event four times in a
single time step, as shown.
9-23
9 Define Events
Each time the chart Callee is activated, the output data y increments by one.
When you simulate the model, you see this output in the scope.
At t = 1, the chart Caller dispatches only one of the four output events. Therefore, the
chart Callee executes once during that time step. However, the chart Caller queues up
the other three event broadcasts for future dispatch that is, one at a time for t = 2,
3, and 4. Each time Caller wakes up in successive time steps, it activates Callee for
execution. Therefore, the action y++ occurs once per time step at t = 1, 2, 3, and 4. During
simulation, Callee executes based on the block sorted order of the Simulink model.
When you cannot use a function-call output event, such as for HDL code generation, you
can approximate a function call by using:
9-24
Activate a Simulink Block Using Output Events
Note: While you can approximate a function call, a subtle difference in execution
behavior exists. Execution of a function-call subsystem occurs during execution of the
chart action that provides the trigger. However, execution of an enabled subsystem
occurs after execution of that chart action is complete.
In the following model, the chart Caller uses the edge-triggered output event
output_cmd to activate the enabled subsystem. The scope shows the value of the output
event during simulation.
The chart Caller broadcasts the edge-triggered output event using a send action.
9-25
9 Define Events
When you simulate the model, you see the following output in the scope. The simulation
runs for 40 seconds.
When simulation starts, the value of output_cmd is 0. At t = 20, the chart dispatches
output_cmd. Because this value changes to 1, the enabled subsystem becomes active
and executes during that time step. Because no other event broadcasts occur, the enabled
9-26
Activate a Simulink Block Using Output Events
subsystem continues to execute at every time step until simulation ends. Therefore, the
Display block shows a final value of 40.
To approximate a function call, add a second event broadcast in the same action.
When you simulate the model, you see the following output in the scope. The simulation
runs for 40 seconds.
9-27
9 Define Events
When simulation starts, the value of output_cmd is 0. At t = 20, the chart dispatches
output_cmd. Because this value changes to 1, the enabled subsystem becomes active
and executes during that time step. The chart also queues up the second event for
dispatch at the next time step. At t = 21, the chart dispatches the second output event,
which changes the value of output_cmd to 0. Therefore, the enabled subsystem stops
executing and the Display block shows a final value of 20.
Use a function-call output event to activate a Simulink block when your model requires
access to output data from the block in the same time step as the function call.
For each output event you define, an output port appears on the Stateflow block.
3 Set the Scope property of the output event to Function call.
The model sf_loop_scheduler shows how to use a function-call output event to activate a
Simulink block. For information on running this model and how it works, see Schedule
One Subsystem in a Single Step on page 24-14.
9-28
Activate a Simulink Block Using Output Events
If a chart tries to broadcast the same function-call output event multiple times in a
single time step, the chart dispatches all the broadcasts in that time step. Execution of
function-call subsystems is interleaved with the execution of the function-call initiator so
that output from the function-call subsystem is available right away in the function-call
initiator. (For details, see Function-Call Subsystems (Simulink).)
9-29
9 Define Events
Note: For information on what happens for edge-triggered output events, see Queuing
Behavior for Broadcasting an Edge-Triggered Output Event Multiple Times on page
9-22.
In this model, the chart Caller uses the function-call output event output_cmd to
activate the chart Callee.
The chart Caller tries to broadcast the same function-call output event four times in a
single time step, as shown.
Each time the chart Callee is activated, the output data y increments by one.
When you simulate the model, you see this output in the scope.
9-30
Activate a Simulink Block Using Output Events
At t = 1, the chart Caller dispatches all four output events. Therefore, the chart Callee
executes four times during that time step. Therefore, the action y++ also occurs four
times in that time step. During simulation, execution of Callee is interleaved with
execution of Caller so that output from Callee is available right away.
All output ports appear sequentially from top to bottom. Output data ports appear
sequentially above output event ports on the right side of a chart block. As you add
output events, their default Port properties appear sequentially at the end of the current
port list.
You can change the default port assignment of an event by resetting its Port property.
When you change the Port property for an output event, the ports for the remaining
output events automatically renumber, preserving the original order. For example,
9-31
9 Define Events
assume you have three output events, OE1, OE2, and OE3, which associate with the
output ports 4, 5, and 6, respectively. If you change the Port property for OE2 to 6, the
ports for OE1 and OE3 renumber to 4 and 5, respectively.
1 In your chart, right-click the state or transition that contains the event of interest
and select Explore.
2 Select the desired event.
9-32
Control Chart Execution Using Implicit Events
Chart waking up
Entry into a state
Exit from a state
Value assigned to an internal data object
These events are implicit because you do not define or trigger them explicitly. Implicit
events are children of the chart in which they occur and are visible only in the parent
chart.
event(object)
where event is the name of the implicit event and object is the state or data in which
the event occurs.
Each keyword below generates implicit events in the action language notation for states
and transitions.
9-33
9 Define Events
If more than one object has the same name, use the dot operator to qualify the name of
the object with the name of its parent. These examples are valid references to implicit
events:
enter(switch_on)
en(switch_on)
change(engine.rpm)
Note: The tick (or wakeup) event refers to the chart containing the action being
evaluated. The event cannot refer to a different chart by argument.
9-34
Control Chart Execution Using Implicit Events
Fan and Heater are parallel (AND) superstates. The first time that an event awakens
the Stateflow chart, the states Fan.Off and Heater.Off become active.
Assume that you are running a discrete-time simulation. Each time that the chart
awakens, a tick event broadcast occurs. After four broadcasts, the transition from
Fan.Off to Fan.On occurs. Similarly, after three broadcasts, the transition from
Heater.Off to Heater.On occurs.
For information about the after operator, see Control Chart Execution Using Temporal
Logic on page 11-56.
9-35
9 Define Events
In multiple parallel states, the same implicit event is used to guard a transition from
one substate to another.
When multiple transitions are valid in the same time step, the transitions execute based
on the order in which they were created in the chart. This order does not necessarily
match the activation order of the parallel states that contain the transitions. For
example, consider the following chart:
When the transition from IV.HERE to IV.THERE occurs, the condition ex(IV.HERE)
is valid for the transitions from A to B for the parallel states I, II, and III. The three
transitions from A to B execute in the order in which they were created: in state I, then
II, and finally III. This order does not match the activation order of those states.
To ensure that valid transitions execute in the same order that the parallel states become
active, use the in operator instead of implicit enter or exit events:
9-36
Control Chart Execution Using Implicit Events
With this modification, the transitions from A to B occur in the same order as activation
of the parallel states. For more information about the in operator, see Check State
Activity on page 11-86.
9-37
9 Define Events
Count Events
In this section...
When to Count Events on page 9-38
How to Count Events on page 9-38
Collect and Store Input Data in a Vector on page 9-38
9-38
Count Events
The chart awakens and remains in the Observe state, until the input data u is positive.
Then, the transition to the state Collect_Data occurs.
After the state Collect_Data becomes active, the value of the input data u is assigned
to the first element of the vector y. While this state is active, each subsequent value of u
is assigned to successive elements of y using the temporalCount operator.
After 10 ticks, the data collection process ends, and the transition to the state Observe
occurs. Just before the state Collect_Data becomes inactive, a function call to status
displays the vector data at the MATLAB prompt.
For more information about ticks in a Stateflow chart, see Control Chart Execution
Using Implicit Events on page 9-33.
9-39
9 Define Events
In state actions (entry, during, exit, and on event_name) and condition actions,
use the send command to broadcast explicit events. Using this command enhances
readability of a chart and ensures that explicit events are not mistaken for data. See
Directed Event Broadcasting on page 11-52 for details.
Do not mix edge-triggered input events and function-call input events in a chart
If you mix input events that use edge triggers and function calls, the chart detects this
violation during parsing, or simulation. An error message appears and chart execution
stops.
Use the in operator instead of the enter implicit event to check state activity. See
Check State Activity on page 11-86 for details.
9-40
10
Messages
The first time a chart transition or action evaluates a message, the chart determines if
the message is present in the queue. If the message is present in the queue, then the
chart removes it from the queue. This message is valid until it is forwarded, or until the
end of the time step. While the message is valid, other transitions or actions can access
the message data. While the message is valid, another transition or action that evaluates
the message will not remove another message from the queue. The chart destroys all
valid messages at the end of the current time step. You access message data by reading it
or writing to it.
When a chart receives a message, it does not trigger the chart to wake up. Events trigger
a chart to wake up. If the receiver chart cannot immediately respond to the event, then
the event is lost. Messages are queued at the message input port until the chart wakes
up. When the chart wakes up, it can respond to the messages in the input queue.
Message lines connect input and output ports in Simulink. You can create local
messages. A local message has its own queue with the same queue properties as the
message input port.
To visualize the interchange of messages during simulation, view the Message Viewer
block.
Related Examples
View Differences Between Stateflow Messages, Events, and Data on page
10-3
Work with Message Viewer on page 10-30
More About
Lifetime of a Stateflow Message on page 10-23
Stateflow Message Syntax in Charts on page 10-11
10-2
View Differences Between Stateflow Messages, Events, and Data
Sender Charts
This model has three sender charts, DataSender, EventSender, and MessageSender.
Each sender chart has one state, A. In the entry action of state A, each chart assigns an
output data value to 1, sends a function-call event, or sends a message.
10-3
10 Messages
Receiver Charts
For each of the sender charts, there is a corresponding receiving chart. Each receiver
chart has a state diagram with states A0, A1, A2, and A3. Each receiver chart has
a transition from A0 to A1 after 3 seconds. The data, event, or message from the
corresponding sender chart guards the transitions between A1, A2, and A3.
10-4
View Differences Between Stateflow Messages, Events, and Data
Scope Output
Each receiver chart has active state output enabled, with the output port connected to
a scope. On the scope output, you see which states are active for each time step. This
output highlights the difference in behavior between output data, event, and message.
10-5
10 Messages
10-6
View Differences Between Stateflow Messages, Events, and Data
Behavior of Data
In the entry action of chart DataSender, the output data M is assigned a value of 1. M
connects as input to the chart DataReceiver. M holds this assigned value throughout
the simulation. Because there is no input event, the chart DataReceiver executes once
every time step. In chart DataReceiver, initially state A0 is active. At t=3, the chart
takes the transition to A1. On the scope, you see the state change from A0 to A1. In the
next time step, t=4, the transition tests if M equals 1. This condition is true, so the chart
takes the transition to A2. At t=5, M still equals 1. The chart transitions from A2 to A3.
After data is assigned a value, it remains valid. Therefore, each time a transition
evaluates M, you see DataReceiver transition to a new state.
10-7
10 Messages
Behavior of Event
The chart EventSender uses the syntax send(M) to send an event as an entry action in
state A. This function-call event is an input event to wake up the chart EventReceiver.
The chart EventReceiver executes only when the input event M wakes the chart up.
When event M wakes up chart EventReceiver, state A0 is active. The chart checks for a
valid transition from state A0. The transition from A0 is based on absolute-time temporal
logic, and is not valid at t=0. A0 remains as the active state, and the chart goes back to
sleep. The chart EventReceiver does not wake up again, because chart EventSender
only sends event M once. On the scope, you see that EventReceiver never transitions
out of A0.
Because events do not remain valid across time steps, the chart has only one chance to
respond to the event. When EventSender sent the event, EventReceiver was not in
a state to respond to it. The ability for EventReceiver to transition in response to the
event is lost.
10-8
View Differences Between Stateflow Messages, Events, and Data
Behavior of Message
The chart MessageSender uses the syntax send(M) to send one message through the
message output port. The message goes in the message input receiving queue for the
chart, MessageReceiver. The message waits until MessageReceiver evaluates it.
Because there is no input event, the chart MessageReceiver executes once every time
step. In MessageReceiver, initially, state A0 is active. The chart transitions to state
A1 at t=3. In the next time step, t=4, the transition determines if M is present. The
chart removes M from the receiver input queue. Because M is valid, the chart takes the
transition to A2. The chart destroys M at the end of the time step t=4. At t=5, another
message is not present in the queue, so the chart does not transition to A3. A2 remains
the active state.
10-9
10 Messages
Unlike events, messages are queued. The receiving chart can choose to respond to a
message anytime after it was sent. Unlike data, the message does not remain valid
across time steps. If the number of messages the chart receives overflows the input
queue, then a message overflow error occurs.
More About
How Messages Work in Stateflow Charts on page 10-2
Queuing Behavior of Stateflow Messages on page 10-21
Stateflow Message Syntax in Charts on page 10-11
10-10
Stateflow Message Syntax in Charts
M.data
Do not access message data for messages that are still in the queue. See Lifetime of a
Stateflow Message on page 10-23.
Send a Message
To send a message, use this syntax:
send(message_name)
If the message scope is Output, then the chart sends the message through the output
port to the input message queue of the receiving chart. If the message is local, then the
message goes in the local message queue.
In this example, M is a message with scope Output. On entry to state A, the chart sends a
message from message output port M, with a data value of 3.
10-11
10 Messages
In a single time step, you can send multiple messages through an output port or to a local
queue. If you send a message without assigning a value to the message data, Stateflow
initializes the message data to 0.
10-12
Stateflow Message Syntax in Charts
time step. While the message is valid, another transition or action that evaluates the
message does not remove another message from the queue. While the message is valid,
other transitions or actions can access the message data.
In this example, the transition checks the message queue M. If there is a message present
in the queue, the chart removes it from the queue. If the data value of the valid message
is equal to 3, then the chart takes the transition from state A to state B. If there was no
message present, or if the data value is not equal to 3, then the chart does not take the
transition.
Note: The message is removed from the queue whether the transition is taken or not.
In this example, when the chart executes state A, the chart checks the message queue
M. If there is a message present, the chart removes it from the queue. If the message
data value is equal to 3, then the chart executes the if statement action. If there is no
message present, the chart does not execute the if statement.
10-13
10 Messages
Receive a Message
To receive a message, use this syntax:
receive(message_name)
In this example, when the chart executes state A, the chart checks the message queue
M. If there is a message present, the chart removes it from the queue. If the message
data value is equal to 3, then the chart executes the if statement action. If there is no
message present, the chart does not execute the if statement.
10-14
Stateflow Message Syntax in Charts
Discard a Message
To discard a message, use this syntax:
discard(message_name)
To discard a message, it must be valid. After you discard a message, you can remove the
next message from the queue within the same time step.
In this example, when the chart executes state A, on entry the chart checks the message
queue M. If there is a message present, the chart removes it from the queue. The chart
then checks if a message was received. If receive(M) returns true, the chart then
checks if the message data value is equal to 3. If the message data value is equal to 3, the
message is discarded.
10-15
10 Messages
Forward a Message
Forward an Input Message
You can forward a message from an input message queue to an output port. A message
line connects the output port to a receiving chart input port in Simulink.
10-16
Stateflow Message Syntax in Charts
After a chart forwards a message, if there is another reference to the same message
queue, then the chart looks for another message on the queue.
You can forward messages to and from local message queues. In this example, if a
message is present at input port M_in, then in state A, Stateflow forwards the message to
the local message queue, M_local. After a 0.3 sec delay, on the transition from state
A to B, the chart determines if a message is present on M_local. The chart removes the
message from the M_local message queue and forwards it to the output port M_out.
10-17
10 Messages
isvalid(message_name)
A message is valid if the chart had removed it from the queue, but it has not been
forwarded or discarded. Use isvalid(M) to check if a message is valid in a Simulink
model that contains more than one Stateflow chart.
In this example, the chart first executes state A. When the chart executes state B, it first
checks to see if message M is valid using isvalid(M). If message M is valid, then the
10-18
Stateflow Message Syntax in Charts
chart executes the if statement action. If message M is not valid, the chart does not
execute the if statement.
length(message_name)
Use length(M) to determine the number of messages in the queue associated with M.
In this example, the chart first executes state A. The queue associated with message
M has been set to a number larger than 75. Once the length of the message queue
associated with M becomes equal to 75, an action within the second if statement is taken.
10-19
10 Messages
Related Examples
Define Messages in a Stateflow Chart on page 10-25
Set Message Properties on page 10-27
10-20
Queuing Behavior of Stateflow Messages
Messages of scope Input and Local have a queue capacity. If the number of incoming
messages exceeds the queue capacity, then a message overflow occurs. Set the diagnostic
action by setting the message queue property Queue overflow diagnostic.
Error (default)
Warning
None
Set the queue capacity high enough so that incoming messages do not overflow the
queue. To check the length of the queue, use length.
To add messages to the Stateflow Breakpoints and Watch window, select Add to Watch
Window while viewing the message in the Property Inspector. When the simulation
pauses, you can view message queues and message data values. To visualize the
interchange of messages, use a Message Viewer block in your model.
Related Examples
Work with Message Viewer on page 10-30
10-21
10 Messages
10-22
Lifetime of a Stateflow Message
While a message is valid, other transitions and actions can guard conditions with the
message and access the message data. When you forward a message, the message
continues its lifetime in the receiving queue.
At the end of a time step, a chart destroys any remaining valid messages. You can
destroy a message during a time step by using discard. To check if a message is valid,
use isvalid.
If the receiving queue is full, a message overflow occurs. Set the diagnostic action by
setting the message queue property Queue overflow diagnostic.
To view the interchange of messages during simulation, add a Message Viewer block. In
this block, you see when messages for a model are:
Sent
Received
Forwarded
Dropped
Destroyed
Discarded
Related Examples
Work with Message Viewer on page 10-30
Stateflow Message Syntax in Charts on page 10-11
10-23
10 Messages
Moore charts
Atomic subcharts
Breakpoint condition expressions
Model reference inputs and outputs
More About
Stateflow Message Syntax in Charts on page 10-11
How Messages Work in Stateflow Charts on page 10-2
10-24
Define Messages in a Stateflow Chart
Scope Description
Input from Simulink Message that is received from another Stateflow chart through
Simulink. Each input message has a receiving queue.
Output to Simulink Message that is sent from a Stateflow through an output port in
Simulink to another chart.
Local Message that is local to the Stateflow chart. A local message has
a receiving queue with the same properties as a message input.
When you send a local message, a transition or action in the
same chart can evaluate the local message. You cannot send a
local message outside the chart.
1
Click the Create Message icon .
2 In the row for the new message, under TYPE, click the icon and choose:
Input Message
Local Message
Output Message
10-25
10 Messages
Connect message input and output ports in Simulink with a message line.
More About
Set Message Properties on page 10-27
How Messages Work in Stateflow Charts on page 10-2
10-26
Set Message Properties
10-27
10 Messages
Error (default)
Warning
None
Queue type For messages of scope Input and Local.
10-28
Set Message Properties
More About
Rules for Naming Stateflow Objects on page 2-4
Watch Stateflow Data Values on page 29-35
Size Stateflow Data on page 8-44
Type Stateflow Data on page 8-36
10-29
10 Messages
To see the interchange of messages between Stateflow charts during simulation, add a
Message Viewer block to the model. You can visualize the movement of entities between
blocks when simulating SimEvents models. The Message Viewer block also displays
function calls and calls from MATLAB Function blocks. For more information on function
calls, see Function Calls in Message Viewer on page 10-39.
The Message Viewer block uses a Message Viewer window that acts like a sequence
diagram showing how blocks interact using messages.
The Message Viewer enables you to view event data related to Stateflow chart execution
and the exchange of messages between Stateflow charts. The Message Viewer shows
where messages are created and sent, forwarded, received, and destroyed at different
times during model execution. You can also view the movement of entities between
SimEvents blocks. All SimEvents blocks that can store entities appear as lifelines on the
Message Viewer. Entities moving between these blocks appear as lines with arrows. The
Message Viewer also enables you to view calls to Simulink Function blocks and Stateflow
MATLAB functions.
This topic uses the Stateflow example sf_msg_traffic_light to show you how to use
the Message Viewer.
You can add one or more Message Viewer blocks to the top level of a model or any
subsystem. If you place a Message Viewer block in a subsystem that does not have
messages, the Message Viewer informs you that no messages are available to display. A
viewer can be inactive if, for example, it is in a subsystem that has been commented out.
In such a case, the Message Viewer displays that it is inactive.
10-30
Work with Message Viewer
Visualize Messages
Consider this subsystem, Traffic Light1:
10-31
10 Messages
Controller
Ped Button Sensor
The charts in this subsystems use messages to exchange data. As messages pass through
the system, you can view them in a Message Viewer.
Add a Message Viewer block from the Stateflow library to a subsystem or model whose
messages you want to see. When you open a Message Viewer block and simulate the
model:
10-32
Work with Message Viewer
The header (top) pane of a Message Viewer shows the lifeline headers. In this
example, the lifelines are the two Traffic Light blocks and the GUI. Lifeline headers
show the name of the corresponding blocks in the model that generate or act on
messages. The top of the lifeline is a header, which corresponds to a block in the
model. Gray headers with straight edges correspond to subsystems. Yellow headers
with rounded edges correspond to Stateflow charts. In the header pane, the lifeline
hierarchy corresponds to the model hierarchy. When the model is paused or stopped,
you can expand and close lifelines.
In the message pane, a thick gray lifeline indicates that you can expand the lifeline
to see the children in the lifeline. Clicking a lifeline name opens the corresponding
block in the model. Messages between lifelines display in the message pane. Message
lines are arrows from the sender to the receiver. For more information on navigation
in the message page, see Navigation in Message Viewers on page 10-38.
2 To show the children of a lifeline, click the expander under a parent lifeline .
10-33
10 Messages
.
4 Make a lifeline the root of focus for the viewer. Hover over the bottom left corner of
the lifeline header and click the arrow. Alternatively, use the navigation toolbar at
the top of a Message Viewer. A Message Viewer displays the current root lifeline
path and shows its child lifelines.
10-34
Work with Message Viewer
Any external sending and receiving events display in the diagram gutter . To
highlight the associated block in the model, click the gutter.
You can use the navigation toolbar to move the current root up and down the lifeline
hierarchy. To move up the current root one level, hit the Esc key.
This graphic also illustrates how the Message Viewer displays masked subsystems.
The Traffic Lamp 1, Ped Lamp 1, Traffic Lamp 2, and PED Lamp 2 are masked
subsystems. The Message Viewer displays masked subsystems as white blocks.
10-35
10 Messages
5 To show the children of a masked subsystem, hover over the bottom left corner of the
masked and subsystem and click the arrow.
6 Activations that correspond to executions of the lifeline are at the start and end of
each message line.
If a message line is not completely shown, hover over the line. You can also, hover
over a truncated message label to see it in its entirety. In this example, the send
time of the commIn message line is not visible. To see it, hover over the message
line.
If you hover over an activation that represents a function call, the function prototype
is displayed in the tool tip.
If you hover over partially shown activation symbols, the times for any truncated
activations also appear.
10-36
Work with Message Viewer
7 A Message Viewer shows the interactions (hops) that a message or function call
goes through in its lifetime. It also shows message and function call payloads. To
highlight the hops for a message and display its payload, click the corresponding
message line. See the result in the payload inspector to the right. Use Search Up
and Down buttons to move through the hops.
toolbar. Saving the model saves the state information across sessions. Use to load the
saved settings.
The time ruler shows linear simulation time. To show messages in that simulation time
range, use the scroll wheel or drag the time slider up and down the time ruler.
10-37
10 Messages
Time Grid
Time Strip
Time Ruler
Time Slider
To navigate to the beginning and end of the simulation, click the Go to first event
and Go to last event buttons.
To zoom the ruler, hold the space bar and use the mouse wheel. This action increases
and decreases the amount of time ruler space the slider occupies.
The time ruler covers the whole simulation time. To see the entire simulation
duration on the time ruler, click the Fit to view button .
To reset the zoom to 100%, hold Ctrl + 0.
To pan in the message pane, move the mouse while holding down either the middle
mouse button or space bar. This action moves both panes.
10-38
Work with Message Viewer
The Message Viewer block does not display these function calls:
See Also
Message Viewer | Message Viewer | Message Viewer
10-39
10 Messages
More About
How Messages Work in Stateflow Charts on page 10-2
10-40
11
name/
entry:entry actions
during:during actions
exit:exit actions
bind:data_name, event_name
on event_name:on event_name actions
on message_name:on message_name actions
For example, different state action types appear in the following chart.
After you enter the name in the state label, enter a carriage return and specify the
actions for the state. The order you use to enter action types in the label does not matter.
11-2
State Action Types
If you do not specify the action type explicitly for a statement, the chart treats that
statement as an entry action.
For a full description of entry, exit, during, bind, and on actions, see the sections
that follow. For more information about the after, before, at, and every temporal
logic operators, see Control Chart Execution Using Temporal Logic on page 11-56.
11-3
11 Use Actions in Charts
In the preceding table, the temporal logic operators use the syntax of event-based
temporal logic. For absolute-time temporal logic, the operators use a different syntax. For
details, see Operators for Absolute-Time Temporal Logic on page 11-63.
Entry Actions
Entry actions are preceded by the prefix entry or en for short, followed by a required
colon (:), followed by one or more actions. Separate multiple actions with a carriage
return, semicolon (;), or a comma (,). If you enter the name and slash followed directly
by actions, the actions are interpreted as entry action(s). This shorthand is useful if you
are specifying entry actions only.
Entry actions for a state execute when the state is entered (becomes active). In the
preceding example in State Action Types on page 11-2, the entry action id = x+y
executes when the state A is entered by the default transition.
For a detailed description of the semantics of entering a state, see Steps for Entering a
State on page 3-74 and State Execution Example on page 3-76.
Exit Actions
Exit actions are preceded by the prefix exit or ex for short, followed by a required colon
(:), followed by one or more actions. Separate multiple actions with a carriage return,
semicolon (;), or a comma (,).
Exit actions for a state execute when the state is active and a transition out of the state
occurs.
For a detailed description of the semantics of exiting a state, see Steps for Exiting an
Active State on page 3-75 and State Execution Example on page 3-76.
During Actions
During actions are preceded by the prefix during or du for short, followed by a required
colon (:), followed by one or more actions. Separate multiple actions with a carriage
return, semicolon (;), or a comma (,).
During actions for a state execute when the state is active and an event occurs and no
valid transition to another state is available.
11-4
State Action Types
For a detailed description of the semantics of executing an active state, see Steps for
Executing an Active State on page 3-75 and State Execution Example on page 3-76.
Bind Actions
Bind actions are preceded by the prefix bind, followed by a required colon (:), followed
by one or more events or data. Separate multiple data/events with a carriage return,
semicolon (;), or a comma (,).
Bind actions bind the specified data and events to a state. Data bound to a state can be
changed by the actions of that state or its children. Other states and their children are
free to read the bound data, but they cannot change it. Events bound to a state can be
broadcast only by that state or its children. Other states and their children are free to
listen for the bound event, but they cannot send it.
Bind actions apply to a chart whether the binding state is active or not. In the preceding
example in State Action Types on page 11-2, the bind action bind: id,
time_out for state A binds the data id and the event time_out to state A. This binding
prevents any other state (or its children) in the chart from changing id or broadcasting
event time_out.
If another state includes actions that change data or broadcast events that bind to
another state, a parsing error occurs. The following example shows a few of these error
conditions:
11-5
11 Use Actions in Charts
Binding a function-call event to a state also binds the function-call subsystem that it
calls. In this case, the function-call subsystem is enabled when the binding state is
entered and disabled when the binding state is exited. For more information about this
behavior, see Control Function-Call Subsystems Using Bind Actions on page 11-95.
On Actions
On actions are preceded by the prefix on, followed by a unique event, event_name, or
message, message_name, followed by one or more actions. Separate multiple actions
with a carriage return, semicolon (;), or a comma (,). You can specify actions for more
than one event or message by adding additional on lines for different events or messages.
11-6
State Action Types
For example, if you want different events to trigger different actions, enter multiple
on event_name action statements in the state's label, each specifying the action for a
particular event or set of events:
on ev1: action1();
on ev2: action2();
On actions execute when the state is active and the event event_name or message
message_name is received by the state. This action coincides with execution of during
actions for the state.
For a detailed description of the semantics of executing an active state, see Steps for
Executing an Active State on page 3-75.
Related Examples
Combine State Actions to Eliminate Redundant Code on page 11-16
11-7
11 Use Actions in Charts
event_or_message trigger[condition]{condition_action}/{transition_action}
11-8
Transition Action Types
11-9
11 Use Actions in Charts
Event triggers specify an event that causes the transition to be taken, provided the
condition, if specified, is true. Specifying an event is optional. Message triggers specify
the transition to be taken if the message is present in the message queue. The absence
of an event or message indicates that the transition is taken upon the occurrence of any
event. Multiple events or messages are specified using the OR logical operator (|).
Conditions
In transition label syntax, conditions are Boolean expressions enclosed in square
brackets ([]). In the example in Transition Action Types on page 11-8, the transition
from state A to state C has the condition temp > 50.
A condition is a Boolean expression to specify that a transition occurs given that the
specified expression is true. Follow these guidelines for defining and using conditions:
The condition expression must be a Boolean expression that evaluates to true (1) or
false (0).
The condition expression can consist of any of the following:
Boolean operators that make comparisons between data and numeric values
A function that returns a Boolean value
An in(state_name) condition that evaluates to true when the state specified as
the argument is active (see Check State Activity on page 11-86)
Note: A chart cannot use the in condition to trigger actions based on the activity
of states in other charts.
Temporal logic conditions (see Control Chart Execution Using Temporal Logic on
page 11-56)
The condition expression can call a graphical function, truth table function, or
MATLAB function that returns a numeric value.
Note: If the condition expression calls a function with multiple return values, only the
first value applies. The other return values are not used.
The condition expression should not call a function that causes the chart to change
state or modify any variables.
11-10
Transition Action Types
Boolean expressions can be grouped using & for expressions with AND relationships
and | for expressions with OR relationships.
Assignment statements are not valid condition expressions.
Unary increment and decrement actions are not valid condition expressions.
Condition Actions
In transition label syntax, condition actions follow the transition condition and are
enclosed in curly braces ({}). In the example in Transition Action Types on page 11-8,
the transition from state A to state C has the condition action func1(), a function call.
Condition actions are executed as soon as the condition is evaluated as true, but before
the transition destination has been determined to be valid. If no condition is specified, an
implied condition evaluates to true and the condition action is executed.
Transition Actions
In transition label syntax, transition actions are preceded with a forward slash (/) and
are enclosed in curly braces ({}). In the example in Transition Action Types on page
11-8, the transition from state A to state B has the transition action data1 = 5. In C
charts, transition actions are not required to be enclosed in curly braces. In charts that
use MATLAB as the action language, the syntax is auto corrected if the curly braces
are missing from the transition action. See Action Language Auto Correction on page
12-6.
Transition actions execute only after the complete transition path is taken. They execute
after the transition destination has been determined to be valid, and the condition, if
specified, is true. If the transition consists of multiple segments, the transition action
executes only after the entire transition path to the final destination is determined to be
valid.
11-11
11 Use Actions in Charts
When you simulate the model, you get the following results:
11-12
Execution of Actions in States and Transitions
11-13
11 Use Actions in Charts
11-14
Execution of Actions in States and Transitions
More About
State Action Types on page 11-2
Transition Action Types on page 11-8
11-15
11 Use Actions in Charts
Combining state actions this way produces the same chart execution behavior
(semantics) and generates the same code as the equivalent separate actions.
11-16
Combine State Actions to Eliminate Redundant Code
Valid Combinations
You can use any combination of the three actions. For example, the following
combinations are valid:
en, du:
en, ex:
du, ex:
en, du, ex:
You can combine actions in any order in the comma-separated list. For example, en,
du: gives the same result as du, en:.
Invalid Combinations
You cannot combine two or more actions of the same type. For example, the following
combinations are invalid:
en, en:
ex, en, ex:
du, du, ex:
If you combine multiple actions of the same type, you receive a warning that the chart
executes the action only once.
1 Entry actions first, from top to bottom in the order they appear in the state
2 During actions second, from top to bottom
3 Exit actions last, from top to bottom
The order in which you combine actions does not affect state execution behavior. For
example:
11-17
11 Use Actions in Charts
1 en: y=y+1;
2 en: y = 0;
3 du: y=y+1;
1 en: y=y+1;
2 en: y = 0;
3 du: y=y+1;
1 en: y=y+1;
2 en: y = 10;
3 du: y=y+1;
4 ex: y = 10;
More About
State Action Types on page 11-2
11-18
Supported Operations on Chart Data
For more predictable results, it is good coding practice to split expressions that depend on
the order of evaluation into multiple statements.
You can specify that the binary operators &, ^, |, &&, and || are interpreted as bitwise
operators in Stateflow generated C code for a chart or for all the charts in a model. See
these individual operators in the table below for specific binary or bitwise operator
interpretations.
11-19
11 Use Actions in Charts
11-20
Supported Operations on Chart Data
11-21
11 Use Actions in Charts
Unary Operations
The following unary operators are supported in C charts. Unary operators have higher
precedence than the binary operators, except for the power operator a ^ b. The power
operator has the highest level of precedence. The operators are evaluated right to left
(right associative).
Example Description
~a Logical NOT of a
Unary Actions
The following unary actions are supported in C charts.
Example Description
a++ Increment a
a-- Decrement a
Assignment Operations
The following assignment operations are supported in C charts.
Example Description
a = expression Simple assignment
a := expression Used primarily with fixed-point numbers. See Assignment
(=, :=) Operations on page 20-30 for a detailed description.
a += expression Equivalent to a = a + expression
a -= expression Equivalent to a = a - expression
a *= expression Equivalent to a = a * expression
a /= expression Equivalent to a = a / expression
11-22
Supported Operations on Chart Data
The following assignment operations are supported in C charts when Enable C-bit
operations is selected in the properties dialog box for the chart. See Specify Chart
Properties on page 22-3.
Example Description
a |= expression Equivalent to a = a | expression (bit operation). See
operation a | b in Binary and Bitwise Operations on page
11-19.
a &= expression Equivalent to a = a & expression (bit operation). See
operation a & b in Binary and Bitwise Operations on page
11-19.
a ^= expression Equivalent to a = a ^ expre