Function Caller

调用 Simulink 函数

全页展开
  • Function Caller block

库:
Simulink / User-Defined Functions

描述

Function Caller 模块调用并执行 Simulink® 函数。Simulink 函数指定函数原型，其中包括函数名称以及输入和输出参量。例如，当 Function Caller 模块调用原型为 y = f(u) 的函数时，Function Caller 模块的输入是 Simulink 函数的输入参量 u，而 Simulink 函数的输出参量 y 是 Function Caller 模块的输出。

在此示例中，Function Caller 模块配置为调用和执行在 Simulink Function 模块中定义的 Simulink 函数 y = timestwo(x)。为了测试函数调用，Sine Wave 模块连接到输入端口 x 以提供输入数据，Scope 模块连接到输出端口 y 以查看输出结果。

A Sine Wave block is the input to the Function Caller block which sends output to a Scope block.

您可以调用通过以下方式定义的 Simulink 函数：Simulink Function 模块、作为导出函数的 Stateflow® Chart (Stateflow)，或 S-Function 模块。有关定义 Simulink 函数的详细信息，请参阅在模型中定义 Simulink 函数。

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

提示

您可以使用 Function Caller 模块来调用模型层次结构之外的函数。

有关详细信息，请参阅Simulink Function Blocks in Referenced Models。

使用 Simulink Function 和 Function Caller 模块的代码生成

如果您有 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)。

示例

重用一个 Simulink 函数的多个实例

重用一个 Simulink 函数的多个实例

要重用组件，请使用一个函数的多个实例。

Monitor Ink Status on Shared Printer Using Simulink Functions

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.

Temperature Control System Communicating with Messages

Temperature Control System Communicating with Messages

Distributed control of room temperatures by processing messages from room thermostats and communicating control commands using messages to different receivers.

端口

输入

全部展开

发送给函数的输入参量的输入信号。

函数原型决定 Function Caller 模块上显示的输入端口的数量和名称。将信号线连接到输入端口，以便通过函数输入参量将数据发送给函数。

例如，y = myfunction(u) 将在 Function Caller 模块上创建一个输入端口 (u)。

数据类型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | fixed point | enumerated | bus

输出

全部展开

函数返回的输出参量的输出信号。

函数原型决定 Function Caller 模块上显示的输出端口的数量和名称。将信号线或消息线连接到输出端口，以便通过函数输出参量接收函数返回的数据。当您选中异步执行函数调用复选框时，Function Caller 模块输出消息。

例如，y = myfunction(u) 在 Function Caller 模块上创建一个输出端口 (y)。

数据类型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | fixed point | enumerated | bus

参数

全部展开

指定 Function Caller 模块和 Simulink 函数之间的函数原型。

注意

要调用在 Simulink Function 模块中定义的函数，需要满足以下条件：

  • 函数调用参量名称必须与函数参量匹配。

  • 函数名称、输入参量和输出参量必须是有效的 MATLAB® 标识符。

编程用法

模块参数：FunctionPrototype
类型：字符向量
值：'y=f(u)' | function prototype
默认值：'y=f(u)'

限定函数名称，指定为字符向量或字符串。

函数名称显示在模块图标上。您可以通过点击模块图标上的参数值并输入新值来编辑名称。

注意

此参数与 Function Caller 模块的函数原型参数自动同步。

有关通过限定解析函数的详细信息，请参阅Scoped Simulink Function Blocks in Models和Scoped Simulink Function Blocks in Subsystems。

编程用法

模块参数：ScopedFunctionName
类型：字符向量
值：'f' | 'Client.f' | function name
默认值：'f'

指定以逗号分隔的 MATLAB 表达式列表，表达式中包含每个输入参量的数据类型、维度和复/实性（实数或虚数）。有关示例，请参阅 Argument Specification for Simulink Function Blocks。

注意

此设定必须与使用 Argument Inport 模块的数据类型参数指定的 Simulink Function 模块的数据类型匹配。

编程用法

模块参数：InputArgumentSpecifications
类型：字符向量
值：'' | MATLAB expression
默认值：''

指定以逗号分隔的 MATLAB 表达式列表，表达式中包含每个输出参量的数据类型、维度和复/实性（实数或虚数）。有关示例，请参阅 Argument Specification for Simulink Function Blocks。

注意

此设定必须与使用 Argument Outport 模块的数据类型参数指定的 Simulink Function 模块的数据类型匹配。

编程用法

模块参数：OutputArgumentSpecifications
类型：字符向量
值：'' | MATLAB expression
默认值：''

指定在对 Simulink 函数的各次调用之间的时间间隔。

默认情况下，模块根据模型中的模块上下文继承其采样时间。要设置不同采样时间，请使用指定采样时间中的表提供的采样时间格式输入值。

如果 Function Caller 模块有任何输入，则它是非源模块，您必须将采样时间设置为 -1。

编程用法

模块参数：SampleTime
类型：字符串 | 字符向量
值：标量 | 向量 | sample time
默认值：'-1'

指定是否异步执行与此 Function Caller 模块关联的 Simulink Function 模块。

  • 选择异步执行函数调用以启用异步执行。

    异步执行是指当调用方调用函数时，该函数根据优先顺序执行并将输出参量返回给调用方。该函数根据在调度编辑器中定义的顺序执行，然后将输出参量返回到调用方。该模块使用消息输出端口输出这些参量。

    • 如果只有一个函数输出参量，该输出参量将成为消息有效负载。

    • 如果有多个函数输出参量，Function Caller 模块将这些输出参量捆绑成一个结构体，该结构体为消息有效负载。

    在即时模式下将消息输出端口连接到一个 Message Triggered Subsystem 模块。Message Triggered Subsystem 模块充当函数的回调。

  • 清除异步执行函数调用以启用同步执行。

    同步执行是指当调用方调用函数时，该函数立即运行并将输出参量返回给调用方。

编程用法

模块参数：AsynchronousCaller
类型：字符向量
值：'on' | 'off'
默认值：'off'

模块特性

数据类型

Boolean | bus | double | enumerated | fixed point | integer | single

直接馈通

是

多维信号

是

可变大小信号

否

过零检测

否

扩展功能

全部展开

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

版本历史记录

在 R2014b 中推出

全部展开

另请参阅

| | | (Stateflow) | |

主题