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

slreportgen.report.ScopeSnapshot 类

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

创建 Simulink 范围快照报告器

自 R2024b 起

全页展开

描述

创建 Simulink® 范围报告器。当添加到报告中时， Simulink 范围报告器会创建指定范围模块的快照，并将快照作为带有可选标题的图像添加到报告中。使用Source属性来指定所需的范围。

注意

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

slreportgen.report.ScopeSnapshot 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

ssReporter = ScopeSnapshot 根据默认报告模板创建一个空的 ScopeSnapshot 对象。使用Source属性来指定要报告的 Simulink 范围模块。将具有空 Source 属性的 ScopeSnapshot 对象添加到报告会产生错误。

ssReporter = ScopeSnapshot(source) 将 Source 属性设置为 source。将此报告器添加到 slreportgen.report.Report 对象，无需任何进一步修改，即可根据 slreportgen.report.Report 对象的默认设置添加范围快照信息。快照在生成的报告中显示为带有标题的图像。请参阅 slreportgen.report.Report。

示例

ssReporter = ScopeSnapshot(Name=Value) 使用一个或多个名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

要为其创建 Simulink 范围报告器的范围模块的路径或句柄，指定为字符串标量或字符向量。

数据类型: char | string

快照报告器，指定为 mlreportgen.report.FormalImage 对象。使用 FormalImage 对象的属性指定快照图像的标题或进一步自定义图像的大小。

注意

报告器初始化 Snapshot 属性。请勿重置此属性。

属性：

GetAccess
公共
SetAccess
公共

快照图像格式，指定为以下格式之一：

导入图像格式支持 HTML支持 Word支持 PDF

支持 PDF/A 格式 (自 R2025a 起)

Windows® 元文件 (.emf)否是否否
图形交换格式 (.gif)是是是是
JPEG 图像 (.jpg)是是是否
PDF (.pdf)否否是否
PDF/A (.pdf)否否是否
可移植网络图形 (.png)是是是是
可缩放矢量图 (.svg)是是是是
TIFF 图像 (.tif)否是是是

注意

与 PDF 报告输出格式不同，PDF/A 格式不支持包含 PDF 或 PDF/A 图像。使用表中列出的图像格式之一将图像包含在 PDF/A 报告中。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

快照图像的缩放选项，指定为 "auto"、"custom" 或 "none"。此属性控制图像文件中快照图像的大小。支持的缩放选项包括：

  • "auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外一英寸的间距。缩放不适用于 HTML 输出。

  • "custom" - 使用此选项可根据 Height 和 Width 属性的值缩放快照图像。

  • "none" - 不执行缩放

注意

"auto" 和 "custom" 选项使用 MATLAB®print 命令来调整图形大小。如果图形太大，无法放入指定的空间，print 命令会裁剪快照图像。为了避免裁剪，请将 Scaling 属性设置为“none”，并使用 Snapshot 属性指定的报告器来调整图像大小。由于报告器将文本与图像的其他部分一起缩小，因此，除非放大图像，否则细节可能无法辨认。请参阅调整图片快照大小。

注意

当出现以下任一属性设置组合时，就会出现 java.lang.OutOfMemoryError：

  • Scaling 设置为 "zoom"，并且 Zoom、MaxHeight 和 MaxWidth 属性设置为较大值

  • Scaling 设置为 "custom"，并且 Height 和 Width 属性设置为较大值

为了避免此错误，对于缩放 Scaling，请使用较小的 Zoom、MaxHeight 和 MaxWidth 属性值。对于 Scaling 设置为 "custom" ，请使用较小的 Height 和 Width 属性值。

数据类型: char | string

快照图像的高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认快照为 6 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

快照图像的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认快照宽度为 6.5 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

是否在快照中保留背景颜色，指定为数字或逻辑值 1 (true) 或 0 (false)。

  • true - 快照的背景颜色与快照源的背景颜色相同，并且忽略 Theme 属性。

  • false - 快照的背景颜色遵循 Theme 属性的设置。

属性：

GetAccess
公共
SetAccess
公共

数据类型: logical

自 R2025a 起

打印快照时使用的图形主题，指定为：

  • "light" - 以白色背景和深色图线及文字打印图窗。

  • "dark" - 以深色背景、浅色图线和文字打印图窗。

如果您手动设置了任何图形颜色，则快照会保留这些颜色，但图窗和坐标区的背景颜色除外，无论主题设置如何。当 PreserveBackgroundColor 为 true 时，此属性将被忽略。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

是否缩放 Simulink 范围时间轴以包含整个日志，指定为数字或逻辑值 1 (true) 或 0 (false)。当设置为 true 时，报告器会缩放时间轴，并且范围窗口的快照将包含整个日志。当此属性设置为 false 时，报告器不会缩放时间轴，并且快照可能不包含整个日志。

数据类型: logical

是否强制打开封闭范围进行快照，指定为 true 或 false。当此属性设置为 true 时，将拍摄上下文中所有范围的快照。此选项强制在报告生成时打开已关闭的范围，然后将其关闭。当设置为 false 时，报告仅包含已打开范围的快照。

数据类型: logical

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

创建报告并添加具有默认和自定义属性的范围快照。

使用默认属性添加范围快照

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

使用默认报告器属性向报告添加范围快照。

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

加载并仿真模型。

model_name = "vdp";
load_system(model_name);
sim(model_name);

创建章节和标题。

chapter = mlreportgen.report.Chapter(Title="Scope Block in Van der Pol Equation Model");

使用范围路径创建 ScopeSnapshot 报告器

reporter = slreportgen.report.ScopeSnapshot("vdp/Scope");

将报告器添加到章节，将章节添加到报告

append(chapter,reporter);
append(rpt,chapter);

使用自定义属性添加范围快照

向报告中添加具有原始范围背景颜色和自定义标题的范围快照。

创建另一个章节和标题。

chapter = mlreportgen.report.Chapter(Title="Customized Version of Scope Snapshot");

使用范围路径创建 ScopeSnapshot 报告器并设置其属性

reporter = slreportgen.report.ScopeSnapshot("vdp/Scope");
reporter.Snapshot.Caption = "Scope Snapshot with Custom Caption";
reporter.PreserveBackgroundColor = true;

将报告器添加到章节，将章节添加到报告

append(chapter,reporter);
append(rpt,chapter);

关闭并查看报告。

close(rpt);
rptview(rpt);

限制

  • 如果使用 parsim 函数运行仿真，则不支持此类。

版本历史记录

在 R2024b 中推出

全部展开

另请参阅

| | | |