本页采用了机器翻译。点击此处可查看英文原文。

slreportgen.report.CFunction 类

命名空间: slreportgen.report

C Function 模块报告器

自 R2021b 起

全页展开

描述

使用 slreportgen.report.CFunction 类的对象来报告 C Function 模块。

默认情况下，CFunction 对象报告：

  • 包含描述参数和任何自定义封装参数的表

  • 列出符号参数内容的表格

  • 由输出代码、启动代码和终止代码参数定义的 C 代码节

使用对象属性来排除或修改报告的信息。

注意

要在报告中使用 CFunction 报告器，您必须使用 slreportgen.report.Report 类创建报告。

slreportgen.report.CFunction 类是 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

rptr = slreportgen.report.CFunction 创建一个具有默认属性值的 CFunction 对象。您必须通过设置 Object 属性来指定要报告的 C Function 模块。使用其他属性来指定报告选项。

rptr = slreportgen.report.CFunction(cFunctionBlock) 指定要报告的 C Function 模块，并将 Object 属性设置为 cFunctionBlock。

示例

rptr = slreportgen.report.CFunction(Name=Value) 使用名称-值参量设置属性。例如，rptr = slreportgen.report.CFunction(Object="slrgex_cfunction/C Function") 将 Object 属性设置为 "slrgex_cfunction/C Function"。您可以指定多个名称-值参量。

属性

全部展开

要报告的 Simulink C Function 模块 ，指定为以下值之一：

注意

如果您使用查找器查找 C Function 模块并将结果直接添加到报告中，则使用 slreportgen.report.CFunction 报告器而不是 slreportgen.report.SimulinkObjectProperties 报告器来报告这些模块。

是否包含模块参数表，指定为 true 或 false。如果此属性为 true，则报告器默认生成一个包含描述参数和任何自定义封装参数的表。输出代码、启动代码、终止代码和 符号参数未包含在此表中，因为它们在单独的节中报告。使用此报告器的 ObjectPropertiesReporter 属性来指定表所包含的参数或自定义表格式。如果参数为空，则报告器不会生成表格。

数据类型: logical

是否包含 C Function 模块使用的符号表，指定为 true 或 false。

数据类型: logical

是否包含用于计算 C Function 模块输出的 C 代码，指定为 true 或 false。

数据类型: logical

是否包含用于在仿真开始时计算 C Function 模块状态的 C 代码，指定为 true 或 false。

数据类型: logical

是否包含 C Function 模块终止时执行的 C 代码，指定为 true 或 false。

数据类型: logical

是否包含在启用 C Function 模块时执行的初始化 C 代码，指定为 true 或 false。如果此属性为 true，则报告器会在报告中包含条件初始化代码。如果 C Function 模块没有定义条件初始化代码，则不会向报告添加任何内容。

数据类型: logical

C Function 模块属性表的格式化程序，指定为 slreportgen.report.SimulinkObjectProperties 对象。该属性的默认值是一个空的 slreportgen.report.SimulinkObjectProperties 对象。您可以通过修改默认对象的属性或将其替换为另一个 SimulinkObjectProperties 对象来自模块属性表的外观。您可以使用 SimulinkObjectProperties 对象的 Properties 属性指定此表中显示的属性。如果 Properties 为空，报告器会根据 C Function 模块参数自动确定要显示哪些属性。

C Function 模块使用的符号表的格式化程序，指定为 mlreportgen.report.BaseTable 对象。该属性的默认值是一个空的 BaseTable 对象，其 StyleName 属性设置为 "CFunctionSymbolsTable"。您可以通过修改默认对象的属性或将其替换为另一个 BaseTable 对象来自定义符号表的外观。添加到 BaseTable 对象的 title 属性的任何内容都会出现在报告中默认生成的表标题之前。

报告的输出、开始和终止代码节的标题的段落格式化程序，指定为 mlreportgen.dom.Paragraph 对象。该属性的默认值是一个空的 Paragraph 对象，其 StyleName 属性设置为 "CFunctionCodeTitle"。您可以通过修改默认对象的属性或将其替换为另一个 Paragraph 对象来自定义代码节标题的外观。此属性中添加到 Paragraph 对象的任何内容都会出现在报告中的代码标题之前。

报告的输出、开始和终止代码节的 C 代码的格式化程序，指定为 mlreportgen.dom.Preformatted 对象。该属性的默认值是一个空的 Preformatted 对象，其中 StyleName 设置为 "CFunctionCode"。您可以通过修改默认对象的属性或将其替换为另一个 Preformatted 对象来自定义 C 代码的外观。此属性中添加到 Preformatted 对象的任何内容都会出现在报告中的格式化代码之前。

自 R2024a 起

要包含的 C 代码类型，指定为 "both"、"simulation" 或 "code generation"。此属性仅当 C Function 模块配置为在生成的代码中使用与用于仿真的 C 代码不同的 C 代码时才适用。否则，该属性将被忽略。

  • "both"（默认）--包括仿真期间使用的 C 代码和生成代码中使用的 C 代码。

  • "simulation" - 仅包含仿真期间使用的 C 代码。

  • "code generation" - 仅包含生成代码中使用的 C 代码。

数据类型: char | string

此报告器的模板来源，以下列方式之一指定：

  • 字符向量或字符串标量，指定包含此报告器模板的文件的路径

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。此报告器的模板必须位于此报告器 TemplateSrc 属性所指定模板的模板库中。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标紧接在输出报告中此报告器的内容之前。

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

此示例会生成一份报告，其中包含有关模型中使用的 C Function 模块的信息。

导入报告 API 包，这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*
import slreportgen.report.*

创建报告。

rpt = slreportgen.report.Report("output","pdf");

加载具有 C Function 模块的模型。

model_name = "slrgex_cfunction";
cFcnObj = "slrgex_cfunction/C Function";
load_system(model_name);

创建章节报告器。

chapter = Chapter(cFcnObj);

创建一个 C Function 模块报告器。默认情况下，报告器包括输出代码、起始代码、终止代码和符号参数，以及报告中的任何其他模块参数。本示例中 C Function 模块的终止代码参数为空。

rptr = CFunction(cFcnObj);

将 C 函数报告器添加到章节中，并将章节添加到报告中。

append(chapter,rptr);
append(rpt,chapter);

关闭并查看报告。

close(rpt);
close_system(model_name);
rptview(rpt);

以下是报告中的 C Function 模块信息：

版本历史记录

在 R2021b 中推出

全部展开

另请参阅

| | |

主题