Main Content

Stateflow.Function

Graphical function in chart, state, box, or function

    Description

    Use Stateflow.Function objects to create graphical functions that contain control-flow logic and iterative loops. You create graphical functions with flow charts that use connective junctions and transitions. You can call a graphical function in the actions of states and transitions. For more information, see Reuse Logic Patterns by Defining Graphical Functions.

    Creation

    Description

    example

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

    Input Arguments

    expand all

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

    Properties

    expand all

    Content

    Name of the graphical function, specified as a character vector.

    Full label for the graphical function, specified as a character vector.

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

    This property is read-only.

    Whether the graphical function is implicitly commented out, specified as a numeric or logical 1 (true) or 0 (false). The graphical function is implicitly commented out when you comment out a superstate in its hierarchy.

    Comment text for the graphical function, specified as a 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 graphical function, the text appears as a tooltip. When you set the IsExplicitlyCommented property to false, the value of CommentText reverts to ''.

    Graphical Appearance

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

    This property is read-only.

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

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

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

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

    Font size for the graphical function label, specified as a scalar. The StateFont.Size property of the chart that contains the graphical function sets the initial value of this property.

    Debugging

    Whether to set the During Function Call breakpoint for the graphical function, specified as a numeric or logical 1 (true) or 0 (false).

    Example: function.Debug.Breakpoints.OnDuring = true;

    Code Generation

    Appearance of the graphical function in generated code, specified as one of these values:

    • 'Auto' — An internal calculation determines the appearance of the function in generated code.

    • 'Function' — The function is implemented as a separate C function.

    • 'Inline' — Calls to the function are replaced by code.

    For more information, see Inline State Functions in Generated Code (Simulink Coder).

    Hierarchy

    This property is read-only.

    Chart that contains the graphical function, specified as a Stateflow.Chart object.

    This property is read-only.

    Subviewer for the graphical function, 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 graphical function.

    This property is read-only.

    Machine that contains the graphical function, specified as a Stateflow.Machine object.

    This property is read-only.

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

    Identification

    Description for the graphical function, specified as a character vector.

    Document link for the graphical function, specified as a character vector.

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

    This property is read-only.

    Session-independent identifier, specified as an integer scalar. Use this property to distinguish the graphical function from other objects in the model.

    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

    classhandleProvide class handle for object
    defaultTransitionsReturn default transitions in object at top level of containment
    dialogOpen properties dialog box
    findSpecified objects in hierarchy
    fitToViewZoom in on graphical object
    getReturn MATLAB structure containing property settings of object or array of objects
    highlightHighlight graphical object
    isCommentedDetermine if object is commented out
    setSet properties with specified values
    upReturn parent of object
    viewDisplay object in editing environment

    Examples

    collapse all

    Add a graphical function in the chart ch. Set its label to '[y1,y2] = f(x1,x2,x3)'.

    function = Stateflow.Function(ch);
    function.LabelString = '[y1,y2] = f(x1,x2,x3)';
    Introduced before R2006a