Stateflow.Box - Box in chart, state, box, or function - MATLAB (original) (raw)

Box in chart, state, box, or function

Description

Use Stateflow.Box objects to organize objects such as functions and states in your chart. You can also use a box to encapsulate states and functions in a separate namespace. For more information, see Group Chart Objects by Using Boxes.

Creation

Syntax

Description

`box` = Stateflow.Box([parent](#box%5Fsep%5Fmw%5F62b5a780-fad8-49c5-adee-9aacc7de28ac)) creates a Stateflow.Box object in a parent chart, state, box, or graphical function.

example

Input Arguments

Properties

expand all

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 andset functions, respectively. For more information, see Modify Properties and Call Functions of Stateflow Objects.

Content

Name of the box, specified as a string scalar or character vector.

Label for the box, specified as a string scalar or character vector.

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

This property is read-only.

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

Since R2023a

This property is read-only.

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

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

Graphical Appearance

Position and size of the box, specified as a four-element numeric vector of the form [left top width height].

This property is read-only.

Whether the box graphically intersects a box, state, or function, specified as a numeric or logical 1 (true) or 0 (false).

Whether the box is a grouped box, specified as a numeric or logical 1 (true) or 0 (false). When you copy and paste a grouped box, you copy not only the box but all of its contents. For more information, see Copy and Paste by Grouping.

Whether the box is a subchart, specified as a numeric or logical 1 (true) or 0 (false).

Whether to display a preview of the box contents, specified as a numeric or logical 1 (true) or 0 (false). This property applies only when the IsSubchart property istrue.

Font size for the box label, specified as a scalar. TheStateFont.Size property of the chart that contains the box sets the initial value of this property.

State Decomposition

Since R2022b

Execution order for the substates of the box in parallel (AND) decomposition, specified as an integer scalar. This property applies only when both of these conditions are satisfied:

• The Decomposition property of the parent state or chart is "PARALLEL_AND".
• The UserSpecifiedStateTransitionExecutionOrder property of the chart that contains the box is true.

Hierarchy

This property is read-only.

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

This property is read-only.

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

This property is read-only.

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

This property is read-only.

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

Identification

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

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

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

This property is read-only.

Unique identifier, specified as an integer scalar. Use this property to distinguish the box 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

Examples

collapse all

Add a box in the chart ch. Set its name toA.

box = Stateflow.Box(ch); box.Name = "A";

Version History

Introduced before R2006a

expand all

Stateflow.Box objects have new object functions and properties:

• The object function getReferences returns the locations where a chart refers to the name of a box.
• The object function renameReferences renames a box and updates all references to the box name in the chart.
• The object function commentedBy identifies the explicitly commented objects that cause a box to be commented out.
• The property IsCommented indicates whether a box is commented out. This property replaces the object functionisCommented.

The ExecutionOrder property specifies the order of execution for the substates of the box in parallel (AND) decomposition.