Simulink Function

使用 Simulink 模块定义函数

全页展开

库:
Simulink / User-Defined Functions

描述

Simulink Function 模块是预配置为能够使用 Simulink^® 模块实现函数的 Subsystem 模块。要使用 Simulink Function 模块定义和调用函数，请执行以下操作：

指定包含函数名称以及输入和输出参量的函数原型，例如 y = f(u)。
使用 Simulink 库中的模块实现函数行为。
配置您的 Simulink Function 模块，以便在模型层次结构中的任何位置调用和重用。

Simulink Function block with view of inside the subsystem.

调用函数时，调用方通过输入参量向函数发送数据，根据实现的行为执行函数，然后通过输出参量从函数接收数据。

有关详细信息，请参阅 Simulink Functions Overview。

指定函数原型

函数原型与函数的实现是分离的。它指定输入和输出参量，以及应该如何从模型层次结构中的其他模块调用该函数。函数原型中指定的每个输入或输出参量分别由 Argument Inport 模块或 Argument Outport 模块表示。您可以通过双击模块上显示的文本来编辑函数原型。

实现函数行为

要实现所需的函数行为，请在子系统中添加任何必需的 Simulink 模块。除了 Argument Inport 和 Argument Outport 模块之外，Simulink Function 模块还可以使用 Inport 和 Outport 模块来输入和输出数据。

有关示例，请参阅Monitor Ink Status on Shared Printer Using Simulink Functions。

配置 Simulink Function 模块

要配置 Simulink Function 模块，请打开位于 Simulink Function 模块内的 Trigger 模块的模块参数。

函数名称 - 指定 Simulink Function 模块的函数名称。
函数可见性 - 选择函数的作用域可见性。
如果函数可见性设置为 port，您还可以指定以下参数：
- 异步执行函数调用 - 指定函数是同步执行还是异步执行。
- 示波器到端口 - 指定导出函数端口的名称。

调用 Simulink 函数

您可以使用函数调用方和函数原型来调用和执行您的函数。在 Simulink Function 模块中定义的函数可以从 Function Caller 模块、Chart (Stateflow)、MATLAB Function 模块、MATLAB System 模块或 S-Function 模块中调用。

有关详细信息，请参阅Call a Simulink Function from a Model。

模型注意事项

当使用 Simulink Function 模块时，考虑您的模型是否需要在函数调用之间的状态持久性或连续采样时间。

函数调用之间的状态持久性 - 如果 Simulink Function 模块包含任何带状态的模块（例如 Unit Delay 或 Memory 模块），则其状态值在函数调用之间是持久性的。如果存在对该函数的多次调用，状态值在来自不同调用方的调用之间也是持久性的。
无法继承连续采样时间 - Simulink Function 模块无法继承连续采样时间。

使用 Simulink Function 模块的代码生成

如果您有 Simulink Coder™ 或 Embedded Coder^®，您可以从包含 Simulink 函数的模型中生成代码。有关详细信息，请参阅 Simulink Function Blocks and Code Generation (Embedded Coder)和Configure Entry-Point Function Interfaces for Simulink Function and Function Caller Blocks (Embedded Coder)。

示例

Monitor Ink Status on Shared Printer Using Simulink Functions

How multiple clients can send requests to a server and receive a status from the server. Using Simulink® functions, different subsystems can call functions from other subsystems and interact in Simulink and Stateflow®. In this example, you model the ink status monitoring of a shared printer using Simulink functions.

打开实时脚本

Model Service Access from Application Software Using Scoped Simulink Functions

Model services and accessing these services from a separate component.

打开实时脚本

函数的动态优先级调度

此示例展示一种常见的建模模式，使用 Stateflow® 图动态安排函数的执行。

打开模型

端口

输入

全部展开

In — 子系统模块的信号输入
标量 | 向量 | 矩阵

在子系统模块中放置一个 Inport 模块会向该模块添加一个外部输入端口。端口标签与 Inport 模块的名称相匹配。

使用 Inport 模块可以从局部环境中接收信号。

ArgIn — 子系统模块的参量输入
标量 | 向量 | 矩阵

子系统模块中的 Argument Inport 模块提供了对应于输入参量的输入端口。子系统模块上不显示端口。

输出

全部展开

Out — 子系统的信号输出
标量 | 向量 | 矩阵

在子系统模块中放置一个 Outport 模块会添加该模块的输出端口。子系统模块上的端口标签是 Outport 模块的名称。

使用 Outport 模块可以向局部环境发送信号。

ArgOut — 子系统模块的参量输出
标量 | 向量 | 矩阵

子系统模块中的 Argument Outport 模块提供对应于输出参量的输出端口。子系统模块上不显示端口。

参数

全部展开

常设

显示端口标签 — 端口标签的显示选项
FromPortIcon (默认) | FromPortBlockName | SignalName | 无

选择如何在 Subsystem 模块图标上显示端口标签。

无 - 不显示端口标签。
FromPortIcon - 如果对应的端口图标显示了信号名称，则在 Subsystem 模块上显示信号名称。否则，如果模块名称是默认名称，则显示端口模块名称或端口号。
FromPortBlockName - 在 Subsystem 模块上显示对应端口模块的名称。
SignalName - 如果连接到端口的信号已命名，则会在 Subsystem 模块上显示信号的名称。否则，显示相应端口模块的名称。

有关 Subsystem 模块上的端口标签编辑，请参阅编辑子系统模块上的端口标签。

编程用法

要以编程方式设置模块参数值，请使用 set_param 函数。

参数:	`ShowPortLabels`
值:	`'FromPortIcon'` (默认) \| `'FromPortBlockName'` \| `'SignalName'` \| `'none'`

读取/写入权限 — 子系统内容的访问级别
ReadWrite (默认) | ReadOnly | NoReadOrWrite

控制用户对子系统内容的访问。

ReadWrite - 允许打开和修改子系统内容。
ReadOnly - 允许打开但不允许修改子系统。如果子系统在模块库中，您可以创建和打开该子系统的链接，创建和修改子系统的本地副本，但不能更改权限或修改原始模块库实例的内容。
NoReadOrWrite - 禁止打开或修改子系统。如果子系统在模块库中，您可以在模型中创建该子系统的链接，但不能打开、修改、更改权限或创建子系统的本地副本。

如果您尝试查看其读取/写入权限参数设置为 NoReadOrWrite 的子系统的内容，将不会收到响应。例如，当您双击此类子系统时，软件不会打开该子系统，并且不显示任何消息。

编程用法

要以编程方式设置模块参数值，请使用 set_param 函数。

参数:	`Permissions`
值:	`'ReadWrite'` (默认) \| `'ReadOnly'` \| `'NoReadOrWrite'`

错误回调函数的名称 — 发生错误时要调用的函数的名称
无默认值

输入软件执行子系统时，如果发生错误要调用的函数的名称。

该软件向函数传递两个参量：子系统的句柄以及指定错误类型的字符向量。如果未指定任何函数，当执行子系统导致错误时，软件将显示常规错误消息。

编程用法

要以编程方式设置模块参数值，请使用 set_param 函数。

参数:	`ErrorFcn`
值:	`''` (默认) \| function name in quotes
数据类型:	`char` \| `string`

允许层次解析 — 工作区变量名称解析
全部 (默认) | ExplicitOnly | 无

选择是否解析此子系统引用的工作区变量的名称。

有关详细信息，请参阅符号解析和符号解析过程。

全部 - 解析此子系统使用的所有工作区变量的名称，包括用来指定模块参数值和 Simulink 数据对象（例如，Simulink.Signal 对象）的工作区变量的名称。
ExplicitOnly - 只解析用来指定模块参数值、数据存储内存（不存在模块）、信号以及标有“must resolve”状态的工作区变量的名称。
无 - 不解析任何工作区变量名称。

编程用法

要以编程方式设置模块参数值，请使用 set_param 函数。

参数:	`PermitHierarchicalResolution`
值:	`'All'` (默认) \| `'ExplicitOnly'` \| `'None'`

注意

要配置 Simulink Function 模块的作用域可见性和同步性，请打开位于 Simulink Function 模块内的 Trigger 模块的模块参数。

模块特性

数据类型	`Boolean^a` \| `bus^a` \| `double^a` \| `enumerated^a` \| `fixed point^a` \| `half^a` \| `image^a` \| `integer^a` \| `single^a` \| `string^a`
直接馈通	`否`
多维信号	`是^a`
可变大小信号	`否`
过零检测	`否`
^a 实际支持的数据类型或功能取决于模块实施。

扩展功能

全部展开

C/C++ 代码生成
使用 Simulink® Coder™ 生成 C 代码和 C++ 代码。

实际代码生成支持取决于模块实现。

定点转换
使用 Fixed-Point Designer™ 设计和仿真定点系统。

实际数据类型支持取决于模块实现。

版本历史记录

在 R2014b 中推出

全部展开

R2024a: 在封装工作区或模型工作区中定义 Simulink Function 模块的变体控制项变量

从 R2024a 开始，您可以在封装或模型工作区中使用更新图激活时间定义 Simulink Function 模块的变体控制项变量。

R2023b: 当作用域限于不同端口时支持不唯一函数名称

如果作用域限于不同端口，则模型根级的 Simulink 函数的函数名称不必唯一。

R2022b: 突出显示引用模型中的相关 Function Caller 模块

从 R2022b 开始，当您选择其相关的 Function Caller 模块位于引用模型中的 Simulink Function 模块时，引用模型的 Function Caller 模块和 Model 模块都会突出显示。

R2022b: 指定异步函数执行

从 R2022b 开始，您可以通过在 Simulink Function 模块内的 Trigger 模块中和 Function Caller 模块中选择新的异步执行函数调用参数，指定要异步执行的 Simulink 函数。

R2022a: 作用域限于端口的 Simulink Function 模块

为 R2022a 添加了新的适用于 Simulink Function 模块的作用域限于端口的可见性选项。要创建一个作用域限于端口的 Simulink Function 模块，请将 Simulink Function 模块内 Trigger 模块的函数可见性参数设置为端口，并在示波器到端口字段中输入端口名称。使用作用域限于端口的 Simulink Function 模块实现通过导出由 Function Element 模块创建的函数端口调用的函数。请参阅Model Client and Server Components Using Function Ports。

另请参阅

模块

Argument Inport | Argument Outport | Trigger | Function Caller | MATLAB Function | Chart (Stateflow) | Function-Call Subsystem | Inport | Outport

Simulink Function

描述

指定函数原型

实现函数行为

配置 Simulink Function 模块

调用 Simulink 函数

模型注意事项

使用 Simulink Function 模块的代码生成

示例

Monitor Ink Status on Shared Printer Using Simulink Functions

Model Service Access from Application Software Using Scoped Simulink Functions

函数的动态优先级调度

端口

输入

In — 子系统模块的信号输入 标量 | 向量 | 矩阵

ArgIn — 子系统模块的参量输入 标量 | 向量 | 矩阵

输出

Out — 子系统的信号输出 标量 | 向量 | 矩阵

ArgOut — 子系统模块的参量输出 标量 | 向量 | 矩阵

参数

常设

显示端口标签 — 端口标签的显示选项 FromPortIcon (默认) | FromPortBlockName | SignalName | 无

编程用法

读取/写入权限 — 子系统内容的访问级别 ReadWrite (默认) | ReadOnly | NoReadOrWrite

编程用法

错误回调函数的名称 — 发生错误时要调用的函数的名称 无默认值

编程用法

允许层次解析 — 工作区变量名称解析 全部 (默认) | ExplicitOnly | 无

编程用法

模块特性

扩展功能

C/C++ 代码生成 使用 Simulink® Coder™ 生成 C 代码和 C++ 代码。

定点转换 使用 Fixed-Point Designer™ 设计和仿真定点系统。

版本历史记录

R2024a: 在封装工作区或模型工作区中定义 Simulink Function 模块的变体控制项变量

R2023b: 当作用域限于不同端口时支持不唯一函数名称

R2022b: 突出显示引用模型中的相关 Function Caller 模块

R2022b: 指定异步函数执行

R2022a: 作用域限于端口的 Simulink Function 模块

另请参阅

模块

主题

In — 子系统模块的信号输入
标量 | 向量 | 矩阵

ArgIn — 子系统模块的参量输入
标量 | 向量 | 矩阵

Out — 子系统的信号输出
标量 | 向量 | 矩阵

ArgOut — 子系统模块的参量输出
标量 | 向量 | 矩阵

显示端口标签 — 端口标签的显示选项
FromPortIcon (默认) | FromPortBlockName | SignalName | 无

读取/写入权限 — 子系统内容的访问级别
ReadWrite (默认) | ReadOnly | NoReadOrWrite

错误回调函数的名称 — 发生错误时要调用的函数的名称
无默认值

允许层次解析 — 工作区变量名称解析
全部 (默认) | ExplicitOnly | 无

C/C++ 代码生成
使用 Simulink® Coder™ 生成 C 代码和 C++ 代码。

定点转换
使用 Fixed-Point Designer™ 设计和仿真定点系统。