主要内容

Stateflow.Function

R2026b

图、状态、框或函数中的图形函数

    描述

    使用 Stateflow.Function 对象创建包含控制流程逻辑和迭代循环的图形函数。您可以使用具有连接结点和转移的流程图创建图形函数。您可以在状态和转移的动作中调用图形函数。有关详细信息,请参阅通过定义图形函数重用逻辑构型。

    创建对象

    描述

    func = Stateflow.Function(parent) 在父图、状态、框或函数中创建一个 Stateflow.Function 对象。

    示例

    输入参量

    全部展开

    新图形函数的父级,指定为以下类型之一的 Stateflow® API 对象:

    属性

    全部展开

    Stateflow API 对象具有与您在 Stateflow 编辑器中设置的值对应的属性。要访问或修改属性,请使用圆点表示法。要访问或修改多个 API 对象的多个属性,请分别使用 get 和 set 函数。有关详细信息,请参阅Modify Properties and Call Functions of Stateflow Objects。

    内容

    图形函数的名称,指定为字符串标量或字符向量。

    图形函数的标签,指定为字符串标量或字符向量。

    是否注释掉图形函数,指定为数值或逻辑值 1 (true) 或 0 (false)。将此属性设置为 true 等效于右键点击图形函数并选择注释掉。有关详细信息,请参阅Comment Out Objects in a Stateflow Chart。

    此 属性 为只读。

    图形函数是否隐式被注释掉,指定为数值或逻辑值 1 (true) 或 0 (false)。当您显式注释掉包含图形函数的对象时,该图形函数会隐式被注释掉。如果图形函数包含在原子子图或原子框中,则此属性为 false,除非显式注释的对象也包含在该原子子图或原子框中。

    自 R2023a 起

    此 属性 为只读。

    图形函数是否被注释掉,指定为数值或逻辑值 1 (true) 或 0 (false)。当 IsExplicitlyCommented 或 IsImplicitlyCommented 为 true 时,此属性为 true。

    图形函数的注释文本,指定为字符串标量或字符向量。此属性仅在 IsExplicitlyCommented 属性为 true 时适用。在 Stateflow 编辑器中,当您指向图形函数上的注释徽章 时,文本显示为工具提示。当您将 IsExplicitlyCommented 属性设置为 false 时,CommentText 的值会还原为 ""。

    图形外观

    图形函数的位置和大小,指定为 [left top width height] 形式的四元素数值向量。

    此 属性 为只读。

    图形函数是否在图形上与框、状态或函数相交,指定为数值或逻辑值 1 (true) 或 0 (false)。

    函数是否为组合函数,指定为数值或逻辑值 1 (true) 或 0 (false)。当您复制并粘贴组合函数时,您不仅复制该函数,还会复制其所有内容。有关详细信息,请参阅Copy and Paste by Grouping。

    函数是否为子图,指定为数值或逻辑值 1 (true) 或 0 (false)。

    是否显示图形函数内容的预览,指定为数值或逻辑值 1 (true) 或 0 (false)。此属性仅在 IsSubchart 属性为 true 时适用。

    图形函数标签的字体大小,指定为标量。包含图形函数的图的 StateFont.Size 属性设置此属性的初始值。

    调试

    图形函数的调试器属性,指定为具有以下属性的 Stateflow.FunctionDebug 对象:

    • Breakpoints.OnDuring - 是否设置 During Function Call 断点,指定为数值或逻辑值 1 (true) 或 0 (false)。

    有关详细信息,请参阅Set Breakpoints to Debug Charts。

    示例: func.Debug.Breakpoints.OnDuring = true;

    代码生成

    图形函数在生成代码中的外观,指定为以下值之一:

    • "Auto" - 内部计算确定函数在生成代码中的外观。

    • "Function" - 函数实现为单独的 C 函数。

    • "Inline" - 只要函数不是递归的一部分,对函数的调用就会被代码替换。

    有关详细信息,请参阅Inline State Functions in Generated Code (Simulink Coder)。

    层次结构

    此 属性 为只读。

    包含图形函数的图,指定为 Stateflow.Chart 对象。

    此 属性 为只读。

    图形函数的子查看器,指定为 Stateflow.Chart、Stateflow.State、Stateflow.Box 或 Stateflow.Function 对象。子查看器是您可以在其上以图形方式查看图形函数的图或子图。

    此 属性 为只读。

    包含图形函数的状态机,指定为 Stateflow.Machine 对象。

    此 属性 为只读。

    图形函数的父级在模型层次结构中的位置,指定为字符向量。

    标识

    图形函数的描述,指定为字符串标量或字符向量。

    图形函数的文档链接,指定为字符串标量或字符向量。

    图形函数的用户定义的标记,指定为任何类型的数据。

    此 属性 为只读。

    会话独立标识符,指定为整数标量。使用此属性区分图形函数与其父图中的其他对象。

    此 属性 为只读。

    唯一标识符,指定为整数标量。与 SSIdNumber 不同,每次启动新 MATLAB® 会话时都会重新分配此属性的值,并且在删除对象后可能会回收该值。

    对象函数

    findIdentify specified objects in hierarchy
    getChildren标识对象的子级
    getParent标识对象的父级
    defaultTransitions识别指定对象中的默认转移
    getReferencesIdentify references to symbol name
    renameReferencesRename symbol and update references to symbol name
    commentedByIdentify objects that implicitly comment out a graphical object
    dialog打开属性对话框
    view在编辑环境中显示对象
    highlight突出显示图形对象
    fitToView放大图形对象

    示例

    全部折叠

    在图 ch 中添加图形函数。将其标签设置为 "[y1,y2] = f(x1,x2,x3)"。

    func = Stateflow.Function(ch);
    func.LabelString = "[y1,y2] = f(x1,x2,x3)";

    版本历史记录

    在 R2006a 之前推出

    全部展开