Stateflow.Junction

Connective or history junction in chart, state, box, or function

Description

Use Stateflow.Junction objects to create junctions that:

• Represent decision points in a transition path

• Record the activity of substates inside a superstate

For more information, see Combine Transitions and Junctions to Create Branching Paths and Resume Prior Substate Activity by Using History Junctions.

Creation

Syntax

junction = Stateflow.Junction(parent)

Description

junction = Stateflow.Junction(parent) creates a Stateflow.Junction object in a parent chart, state, box, or graphical function.

Input Arguments

parent — Parent for new junction

Stateflow.Chart object | Stateflow.State object | Stateflow.Box object | Stateflow.Function object

Parent for the new junction, specified as a Stateflow^® API object of one of these types:

• Stateflow.Box

• Stateflow.Chart

• Stateflow.Function

• Stateflow.State

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

Type — Type of junction

"CONNECTIVE" (default) | "HISTORY"

Type of junction, specified as one of these values:

• "CONNECTIVE" — Connective junction that represents a decision point in a transition path

• "HISTORY" — History junction that records the activity of substates inside a superstate

IsExplicitlyCommented — Whether to comment out junction

false or 0 (default) | true or 1

Whether to comment out the junction, specified as a numeric or logical 1 (true) or 0 (false). Setting this property to true is equivalent to right-clicking the junction and selecting Comment Out. For more information, see Comment Out Objects in a Stateflow Chart.

IsImplicitlyCommented — Whether junction is implicitly commented out

true or 1 | false or 0

This property is read-only.

Whether the junction is implicitly commented out, specified as a numeric or logical 1 (true) or 0 (false). The junction is implicitly commented out when you explicitly comment out an object that contains it. If the junction is contained in an atomic subchart or an atomic box, this property is false unless the explicitly commented object is also contained in the atomic subchart or atomic box.

IsCommented — Whether junction is commented out

true or 1 | false or 0

Since R2023a

This property is read-only.

Whether the junction is commented out, specified as a numeric or logical 1 (true) or 0 (false). This property is true when either IsExplicitlyCommented or IsImplicitlyCommented is true.

CommentText — Comment text

"" (default) | string scalar | character vector

Comment text added to the junction, specified as a string scalar or character vector. This property applies only when the IsExplicitlyCommented property is true. In the Stateflow Editor, when you point to the comment badge on the junction, the text appears as a tooltip. When you set the IsExplicitlyCommented property to false, the value of CommentText reverts to "".

Graphical Appearance

Position — Position and size of junction

Stateflow.JunctionPosition object

Position and size of the junction, specified as a Stateflow.JunctionPosition object with these properties:

• Center — Position of the center of the junction, specified as a two-element numeric vector [x y] of coordinates relative to the upper left corner of the chart.

• Radius — Radius of the junction, specified as a scalar.

Example: junction.Position.Center = [31.41 27.18];

Example: junction.Position.Radius = 16.18;

ArrowSize — Size of incoming transition arrows

8 (default) | scalar

Size of incoming transition arrows, specified as a scalar.

Hierarchy

Chart — Chart that contains junction

Stateflow.Chart object

This property is read-only.

Chart that contains the junction, specified as a Stateflow.Chart object.

Subviewer — Subviewer for junction

Stateflow.Chart object | Stateflow.State object | Stateflow.Box object | Stateflow.Function object

This property is read-only.

Subviewer for the junction, specified as a Stateflow.Chart, Stateflow.State, Stateflow.Box, or Stateflow.Function object. The subviewer is the chart or subchart where you can graphically view the junction.

Machine — Machine that contains junction

Stateflow.Machine object

This property is read-only.

Machine that contains the junction, specified as a Stateflow.Machine object.

Path — Location of parent in model hierarchy

character vector

This property is read-only.

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

Identification

Description — Description

"" (default) | string scalar | character vector

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

Document — Document link

"" (default) | string scalar | character vector

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

Tag — User-defined tag

[] (default) | any data type

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

SSIdNumber — Session-independent identifier

scalar

This property is read-only.

Session-independent identifier, specified as an integer scalar. Use this property to distinguish the junction from other objects in its parent chart.

Id — Unique identifier

scalar

This property is read-only.

Unique identifier, specified as an integer scalar. Unlike SSIdNumber, 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

getParent	Identify parent of object
sinkedTransitions	Identify transitions with specified destination
sourcedTransitions	Identify transitions with specified source
commentedBy	Identify objects that implicitly comment out a graphical object
dialog	Open properties dialog box
view	Display object in editing environment
highlight	Highlight graphical object
fitToView	Zoom in on graphical object

Examples

Add Connective Junction to Chart

Add a connective junction in the chart ch. Change its size and position.

junction = Stateflow.Junction(ch);
junction.Position.Radius = 16.18;
junction.Position.Center = [31.41 27.18];

Add History Junction to Chart

Add a history junction in the chart ch.

junction = Stateflow.Junction(ch);
junction.Type = "HISTORY";

Version History

Introduced before R2006a

R2023a: New object function and property

Use the object function commentedBy and the property IsCommentedto investigate commented-out junctions:

• The object function commentedBy identifies the explicitly commented objects that cause a junction to be commented out.

• The property IsCommented indicates whether a junction is commented out. This property replaces the object function isCommented.