Stateflow.StateTransitionTableRow

R2026b

Row in a state transition table

Since R2026b

Description

Use Stateflow.StateTransitionTableRow objects to programmatically read and modify rows in a Stateflow^® state transition table. A row represents a state, a default transition path, or an inner transition path in the table. For more information, see Model Finite State Machines Using State Transition Tables.

Creation

Syntax

row = stt.addStateRow()

row = stt.addDefaultTransitionPathRow()

row = parentRow.addChildStateRow()

row = existingRow.addStateRowBelow()

row = parentRow.addInnerTransitionPathRow()

row = parentRow.addDefaultTransitionPathRow()

Description

row = stt.addStateRow() creates a Stateflow.StateTransitionTableRow object by adding a state row to the state transition table stt and returning the new row.

row = stt.addDefaultTransitionPathRow() creates a Stateflow.StateTransitionTableRow object by adding a default transition path row to the state transition table stt and returning the new row.

row = parentRow.addChildStateRow() creates a Stateflow.StateTransitionTableRow object by adding a child state row to an existing row parentRow and returning the new row.

row = existingRow.addStateRowBelow() creates a Stateflow.StateTransitionTableRow object by adding a state row at the same level as the existing row existingRow and returning the new row.

row = parentRow.addInnerTransitionPathRow() creates a Stateflow.StateTransitionTableRow object by adding an inner transition path row to the existing row parentRow and returning the new row.

row = parentRow.addDefaultTransitionPathRow() creates a Stateflow.StateTransitionTableRow object by adding a default transition path row to the existing row parentRow and returning the new row. This clears all default transitions at the current level.

Properties

Stateflow API objects have properties that correspond to the values you set in the Stateflow Editor. To access or modify a property, use dot notation. To access or modify multiple properties for multiple API objects, use the get and set functions, respectively. For more information, see Modify Properties and Call Functions of Stateflow Objects.

Row Identification

RowType — Type of row

Read-only: "state" | "default-transition" | "inner-transition"

This property is read-only.

Type of row, returned as a string. The value is one of these options:

• "state" — The row represents a state.

• "default-transition" — The row represents a default transition path.

• "inner-transition" — The row represents an inner transition path.

Note

The exportAsStruct function returns a rowType structure field that uses numeric values to represent the same row type information.

Name — Name of the state

"" (default) | string scalar | character vector

Name of the state, specified as a string scalar or character vector. This property applies only to state rows.

LabelString — Full label string of the state

"" (default) | string scalar | character vector

Full label string of the state, specified as a string scalar or character vector. The label string encodes the state name and all associated actions. Setting this property updates the EntryAction, DuringAction, ExitAction, and OnAction properties accordingly.

State Actions

EntryAction — Entry action of the state

Read-only: string scalar | character vector

This property is read-only.

Entry action of the state, returned as a character vector. To set the entry action, update the LabelString property by using the en: prefix in the label string. This property applies only to state rows.

DuringAction — During action of the state

Read-only: string scalar | character vector

This property is read-only.

During action of the state, returned as a character vector. To set the during action, update the LabelString property by using the du: prefix in the label string. This property applies only to state rows.

ExitAction — Exit action of the state

Read-only: string scalar | character vector

This property is read-only.

Exit action of the state, returned as a character vector. To set the exit action, update the LabelString property by using the ex: prefix in the label string. This property applies only to state rows.

OnAction — On action of the state

Read-only: string scalar | character vector

This property is read-only.

On action of the state, returned as a character vector. To set the on action, update the LabelString property by using the on event_name: prefix in the label string (for example, "on ev: x = 0;"). This property applies only to state rows.

Hierarchy

Decomposition — Decomposition type of the state

"EXCLUSIVE_OR" (default) | "PARALLEL_AND"

Decomposition type of the state, specified as a string scalar or character vector. The value is one of these options:

• "EXCLUSIVE_OR" — Child states are mutually exclusive. Only one child state is active at a time.

• "PARALLEL_AND" — Child states are active simultaneously.

Setting this property updates the decomposition type in the state transition table UI and the underlying chart. This property applies only to state rows. For more information, see Define Exclusive and Parallel Modes by Using State Decomposition.

IsDefaultState — Whether the state is the target of the default transition

false or 0 (default) | true or 1

Whether the state is the target of the default transition, specified as a numeric or logical 1 (true) or 0 (false). Setting this property to true marks the state as the default state at its level of the hierarchy. This property applies only to state rows.

Setting this property throws an error in these cases:

• The row is a default transition path row or an inner transition path row and the value is true.

• The row is the only child state at its level and the value is false.

• The parent row already has a default transition path row and the value is true.

• The parent row uses parallel decomposition and the value is true.

DefaultTransitionPathRow — Default transition path row for the state

Read-only: Stateflow.StateTransitionTableRow object

This property is read-only.

Default transition path row for the state, returned as a Stateflow.StateTransitionTableRow object. If the state does not have a default transition path row, this property returns an empty array. This property applies only to state rows.

InnerTransitionPathRow — Inner transition path row for the state

Read-only: Stateflow.StateTransitionTableRow object

This property is read-only.

Inner transition path row for the state, returned as a Stateflow.StateTransitionTableRow object. If the state does not have an inner transition path row, this property returns an empty array. This property applies only to state rows.

HasHistoryJunction — Whether the state has a history junction

false or 0 (default) | true or 1

Whether the state has a history junction, specified as a numeric or logical 1 (true) or 0 (false). Setting this property to true adds a history junction to the state. A history junction causes the state to re-enter the last active child state rather than the default child state. This property applies only to state rows. For more information, see Resume Prior Substate Activity by Using History Junctions.

Object Functions

addChildStateRow	Add child state row to state transition table row
addStateRowBelow	Add sibling state row below existing row in state transition table
addInnerTransitionPathRow	Add inner transition path row to state transition table row
addDefaultTransitionPathRow	Add default transition path row to state transition table
getRow	Get state row by name from state transition table or parent row
getRows	Get all rows from state transition table or parent row
getDefaultState	Get default state row from state transition table or parent row
getParent	Identify parent of object
getTransitionCell	Get transition cell at specified row and column index in state transition table
deleteRow	Delete row from state transition table
find	Identify specified objects in hierarchy

Examples

Add a State Row to a State Transition Table

Open a model that contains a state transition table and get a handle to the table.

open_system("myModel")
stt = find(sfroot, "-isa", "Stateflow.StateTransitionTableChart", ...
    "Name", "mySTT");

Add a state row to the table. The new row appends to the end of the table.

row = stt.addStateRow();
row.Name = "Idle";

Add a label string that defines an entry action for the state.

row.LabelString = "Idle" + newline + "en: x = 0;";

Add Child State Rows and Transition Paths

Get a handle to an existing state row by using getRow.

row = stt.getRow("Active");

Add child state rows and mark one as the default state.

childRow1 = row.addChildStateRow();
childRow1.Name = "Running";
childRow1.IsDefaultState = true;
childRow2 = row.addChildStateRow();
childRow2.Name = "Paused";

Add an inner transition path row to the state. Inner and default transition path rows require the parent state to have child states.

innerRow = row.addInnerTransitionPathRow();
innerRow.RowType

Add a default transition path row to the state.

defaultRow = row.addDefaultTransitionPathRow();
defaultRow.RowType

Add a Sibling State Row

Get a handle to an existing state row and add a sibling state row below it.

row = stt.getRow("Idle");
siblingRow = row.addStateRowBelow();
siblingRow.Name = "Active";

Version History

Introduced in R2026b

R2026b: Introduced

Stateflow.StateTransitionTableRow objects are introduced in R2026b as part of the expanded Stateflow state transition table API.