Stateflow.Machine

Container for Stateflow blocks in a Simulink model

Description

From a Stateflow^® perspective, Stateflow.Machine objects are equivalent to Simulink^® models. A Stateflow.Machine object contains Stateflow.Chart, Stateflow.StateTransitionTableChart, Stateflow.TruthTableChart, and Stateflow.EMChart objects that represent the Stateflow charts, State Transition Table blocks, Truth Table blocks, and MATLAB Function blocks in a Simulink model. For more information, see Overview of the Stateflow API.

Creation

You automatically create a Stateflow.Machine object when you load a model that contains a Stateflow block or call the function sfnew. To access the Stateflow.Machine object, call the find function for the Simulink.Root object. For example, if your Simulink model is named myModel, enter:

machine = find(sfroot,"-isa","Stateflow.Machine",Name="myModel");

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.

Content

Name — Name of Simulink model

Read-only: character vector

This property is read-only.

Name of the Simulink model for the machine, specified as a character vector.

FullFileName — Full file path of Simulink model

Read-only: character vector

This property is read-only.

Full file path of the Simulink model for the machine, specified as a character vector.

IsLibrary — Whether model builds library

Read-only: false or 0 (default) | true or 1

This property is read-only.

Whether the Simulink model for the machine builds a library and not an application, specified as a numeric or logical 1 (true) or 0 (false).

Debugging

Debug — Debugger properties

Stateflow.MachineDebug object

Debugger properties for charts in the machine, specified as a Stateflow.MachineDebug object with these properties:

• Animation.Enabled — Whether to animate the charts in the machine during simulation, specified as a numeric or logical 1 (true) or 0 (false). Disabling this property is equivalent to selecting None in the Animation Speed drop-down list in the Debug tab.

• Animation.Delay — Delay that the chart animation uses for highlighting each transition segment in the machine, specified as a scalar. These values correspond to the settings of the Animation Speed drop-down list in the Debug tab:

  Delay Value	Animation Speed
  0.5	Slow
  0.2	Medium
  0	Fast
  -1	Lightning Fast

• Animation.MaintainHighlighting — Whether to maintain the highlighting of active states in the machine after the simulation ends, specified as a numeric or logical 1 (true) or 0 (false).

Example: machine.Debug.Animation.Enabled = true;

Example: machine.Debug.Animation.Delay = -1;

Hierarchy

Path — Location of machine in model hierarchy

Read-only: character vector

This property is read-only.

Location of the machine in the model hierarchy, specified as a character vector.

Dirty — Whether model has changed

true or 1 | false or 0

Whether the Simulink model for the machine has changed after being opened or saved, specified as a numeric or logical 1 (true) or 0 (false).

Locked — Whether machine is locked

false or 0 (default) | true or 1

Whether the machine is locked, specified as a numeric or logical 1 (true) or 0 (false). Enable this property to prevent changes in the Stateflow charts, state transition tables, and truth table blocks in this machine.

Iced — Whether machine is locked

Read-only: false or 0 (default) | true or 1

This property is read-only.

Whether the machine is locked, specified as a numeric or logical 1 (true) or 0 (false). This property is equivalent to the property Locked, but is used internally to prevent changes in the machine during simulation.

Identification

Created — Date of creation

Read-only: character vector

This property is read-only.

Date of the creation of the machine, specified as a character vector.

Creator — Creator

"Unknown" (default) | string scalar | character vector

Creator of the machine, specified as a string scalar or character vector.

Modified — Record of modifications

"" (default) | string scalar | character vector

Record of modifications to the machine, specified as a string scalar or character vector.

Version — Version

"none" (default) | string scalar | character vector

Version of the machine, specified as a string scalar or character vector.

Description — Description

"" (default) | string scalar | character vector

Description for the machine, specified as a string scalar or character vector.

Document — Document link

"" (default) | string scalar | character vector

Document link for the machine, specified as a string scalar or character vector.

Tag — User-defined tag

[] (default) | any data type

User-defined tag for the machine, specified as data of any type.

Id — Unique identifier

Read-only: scalar

This property is read-only.

Unique identifier, specified as an integer scalar. Use this property to distinguish the machine from other objects in the model. The value of this property is reassigned every time you start a new MATLAB^® session and may be recycled after an object is deleted.

Object Functions

find	Identify specified objects in hierarchy
dialog	Open properties dialog box

Examples

Update Machine Version

Update the Modified and Version properties of machine machine.

machine.Modified = string(datetime);
oldVersion = str2double(machine.Version);
if isnan(oldVersion) 
    machine.Version = "1";
else
    machine.Version = string(oldVersion+1);
end

Version History

Introduced before R2006a