State Methods :: API Properties and Methods by Object (Stateflow User's Guide)

Stateflow User's Guide

State Methods

State objects have the methods displayed in the table below. For details on each method, see the reference pages.

See also State Properties.

Method
Description

defaultTransitions
Return the default transitions in this state at the top level of containment.

delete
Delete this state.

dialog
Display the properties dialog of this state.

disp
Display the property names and their settings for this State object.

find
Find all objects that this state contains that meet the specified criteria.

get
Return the specified property settings for this state.

help
Display a list of properties for this State object with short descriptions.

innerTransitions
Return the inner transitions that originate with this state and terminate on a contained object.

methods
Display all nonglobal methods of this State object.

outerTransitions
Return an array of transitions that exit the outer edge of this state and terminate on an object outside the containment of this state.

outputData
Output the activity status of this state to Simulink via a data output port on the chart block of this state.

set
Set the specified property of this State object with the specified value.

sourcedTransitions
Return all inner and outer transitions whose source is this state.

struct
Return and display a MATLAB structure containing the property settings of this State object.

view
Display this state's chart in a diagram editor with this state highlighted.

Method	Description
`defaultTransitions`	Return the default transitions in this state at the top level of containment.
`delete`	Delete this state.
`dialog`	Display the properties dialog of this state.
`disp`	Display the property names and their settings for this State object.
`find`	Find all objects that this state contains that meet the specified criteria.
`get`	Return the specified property settings for this state.
`help`	Display a list of properties for this State object with short descriptions.
`innerTransitions`	Return the inner transitions that originate with this state and terminate on a contained object.
`methods`	Display all nonglobal methods of this State object.
`outerTransitions`	Return an array of transitions that exit the outer edge of this state and terminate on an object outside the containment of this state.
`outputData`	Output the activity status of this state to Simulink via a data output port on the chart block of this state.
`set`	Set the specified property of this State object with the specified value.
`sourcedTransitions`	Return all inner and outer transitions whose source is this state.
`struct`	Return and display a MATLAB structure containing the property settings of this State object.
`view`	Display this state's chart in a diagram editor with this state highlighted.

State Properties Box Properties