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

slreportgen.report.MATLABSystem 类

命名空间: slreportgen.report
超类: slreportgen.report.Reporter

MATLAB 系统模块报告器

自 R2023a 起

全页展开

描述

使用 slreportgen.report.MATLABSystem 类的对象来报告 Simulink® MATLAB System 模块。

默认情况下，MATLABSystem 报告器会将此信息添加到报告中：

  • Simulink MATLAB System 模块属性

  • MATLAB System 模块的输入和输出参量摘要

  • MATLAB System 模块源代码

注意

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

slreportgen.report.MATLABSystem 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

reporter = slreportgen.report.MATLABSystem 根据默认模板创建一个空的 MATLABSystem 报告器。使用 Object 属性指定 Simulink MATLAB System 模块。

示例

reporter = slreportgen.report.MATLABSystem(mlSysObj) 将 Object 属性设置为 mlSysObj 指定的 MATLAB System 模块。

reporter = MATLABSystem(Name=Value) 使用名称-值参量设置 MATLABSystem 报告器属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

MATLAB 要报告的系统，指定为以下值之一：

  • 包含 MATLAB System 模块路径的字符向量或字符串标量

  • MATLAB System 模块的句柄

  • slreportgen.finder.BlockResult 对象

  • slreportgen.finder.DiagramElementResult 对象

注意

如果您使用查找器查找 MATLAB System 模块并将结果直接添加到报告中，则查找器将返回 slreportgen.report.MATLABSystem 报告器而不是 Simulink 对象属性报告器。

是否包含对象属性，指定为 true 或 false。如果值为 true，则报告将包含 MATLAB System 模块的属性表。

对象属性报告器，指定为 mlreportgen.report.BaseTable 对象。MATLABSystem 报告器使用此报告器创建 MATLAB System 模块的属性表。

要自定义对象属性表及其标题的外观，请自定义默认的 BaseTable 报告器或将其替换为自定义版本的 BaseTable 报告器。要自定义对象属性表的标题，请在默认或替换报告器的 Title 属性中指定内容。您指定的内容将放置在默认标题的前面。

是否包含参量摘要，指定为 true 或 false。

如果为真，报告将包括 MATLAB System 模块的输入和输出参量的摘要表。默认情况下，参量摘要表包括所有输入和输出参量的名称、范围、端口、数据类型和大小。

使用 ArgumentSummaryProperties 属性来自定义要在摘要表中报告的属性集。

要包含的参量属性，指定为字符向量元胞数组或字符串数组。

指定这些属性的任意组合：

  • Name

  • Scope

  • Port

  • Data Type

  • Size

  • Complex

  • Fixed Size

参量摘要报告器，指定为 mlreportgen.report.BaseTable 对象。此属性指定用于创建 MATLAB System 模块的输入和输出参量的摘要表的报告器。该属性的默认值是 mlreportgen.report.BaseTable 对象。您可以通过自定义默认报告器或将其替换为 BaseTable 报告器的自定义版本来自定义表的外观。您在默认或替换报告器的 Title 属性中指定的任何内容都将出现在生成的报告的标题之前。

是否包含具有每个参量详细信息的属性表，指定为 true 或 false。

参量摘要表包括所有输入和输出参量的名称、范围、端口、数据类型和大小，如下所示：

MATLAB System block reporter argument property table

使用报告器的 ArgumentSummaryProperties 属性来自定义摘要表中要报告的属性集。

参量属性报告器，指定为 mlreportgen.report.BaseTable 对象。此属性指定要用作创建 MATLAB System 模块的输入和输出参量的属性表的基础的报告器。MATLABSystem 报告器为要报告的每个参量创建一个该报告器的副本，并使用该副本来报告参量的属性。该属性的默认值是 mlreportgen.report.BaseTable 对象。您可以通过自定义默认报告器或将其替换为 BaseTable 报告器的自定义版本来自定义表的外观。您在默认或替换报告器的 Title 属性中指定的任何内容都将出现在生成的报告的标题之前。

是否包含源代码，指定为 true 或 false。如果是 true，报告包含 MATLAB 系统的源代码。

源代码报告器，指定为 mlreportgen.report.MATLABCode 对象。这是用于报告和格式化 MATLAB 系统源代码的报告器。该属性的默认值是 MATLABCode 报告器类型的对象。要自定义代码外观，请修改默认 MATLABCode 报告器的属性或用自定义报告器替换该报告器。

源代码标题，指定为字符向量、字符串标量或 mlreportgen.dom.Paragraph 对象。SourceCodeTitle 为该报告器指定一个 DOM Paragraph 对象，以填充 MATLAB 系统源代码的标题内容。该属性的默认值是一个空段落，其属性指定源代码标题的外观。默认情况下，MATLABSystem 报告器会根据 MATLAB System 模块名称生成一个标题并将其附加到段落。生成的标题由 MATLAB System 模块名称后跟“源代码”组成，例如“分析和绘图源代码”。您可以通过修改默认段落对象的属性或将其替换为另一个段落对象来自定义标题外观。您添加到段落的内容将显示在生成的报告的标题之前。

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

从文本文件创建一份段落报告。

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

import slreportgen.report.*

创建 PFD 报告。

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

加载模型。

model_name = "slrgex_slexLawOfLargeNumbersExample";
mlSysObj = strcat(model_name,"/Analysis and Plot");
load_system(model_name);

创建一个章节。

chapter = mlreportgen.report.Chapter(mlSysObj);

创建一个 MATLABSystem 报告器。

rptr = slreportgen.report.MATLABSystem(mlSysObj);

将 MATLABSystem 报告器添加到要报告的章节和章节

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

关闭并查看报告。

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

版本历史记录

在 R2023a 中推出

另请参阅

| | | | | | | |

主题