Specifying Function Properties :: Extending Stateflow Chart Diagrams (Stateflow User's Guide)

Stateflow User's Guide

Specifying Function Properties

You can set general properties for a function through its function dialog as follows:

Right-click the function box.
Select Properties from the resulting submenu.

The Function Properties dialog for the function appears, as shown:

The fields in the Function Properties dialog are as follows:

Field
Description

Name
Function name; read-only; click this hypertext link to bring the function to the foreground in its native diagram.

Parent
Parent of this function; read-only; a forward slash character (/) indicates that the Stateflow diagram is the parent; click this hypertext link to bring the parent to the foreground in its native diagram.

Debugger breakpoints
Select Function Call to set a breakpoint to pause execution during simulation when the function is called.

Function Inline Option
This option controls the inlining of this function in generated code through the following selections:
Auto
Stateflow decides whether or not to inline the function based on an internal calculation.

Inline
Stateflow inlines the function as long as it is not exported to other charts and is not part of a recursion. A recursion exists if the function calls itself either directly or indirectly through another called function.

Function
The function is not inlined.

Label
You can specify the signature label for the function through this field. See Creating a Function for more information.

Description
Textual description/comment.

Document Link
Enter a URL address or a general MATLAB command. Examples are www.mathworks.com, mailto:email_address, and edit/spec/data/speed.txt.

Field	Description
Name	Function name; read-only; click this hypertext link to bring the function to the foreground in its native diagram.
Parent	Parent of this function; read-only; a forward slash character (/) indicates that the Stateflow diagram is the parent; click this hypertext link to bring the parent to the foreground in its native diagram.
Debugger breakpoints	Select Function Call to set a breakpoint to pause execution during simulation when the function is called.
Function Inline Option	This option controls the inlining of this function in generated code through the following selections: Auto Stateflow decides whether or not to inline the function based on an internal calculation. Inline Stateflow inlines the function as long as it is not exported to other charts and is not part of a recursion. A recursion exists if the function calls itself either directly or indirectly through another called function. Function The function is not inlined.
Label	You can specify the signature label for the function through this field. See Creating a Function for more information.
Description	Textual description/comment.
Document Link	Enter a URL address or a general MATLAB command. Examples are `www.mathworks.com`, `mailto:email_address`, and `edit/spec/data/speed.txt`.

Exporting Functions Using Boxes to Extend Chart Diagrams