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

slreportgen.report.Notes 类

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

Simulink 或 Stateflow 图注释报告器

全页展开

描述

创建一个报告器，报告 Simulink® 或 Stateflow® 图注释。有关模型注释的详细信息，请参阅 Write In-Model Documentation Using Notes。

注意

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

slreportgen.report.Notes 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

notes = slreportgen.report.Notes 创建一个空的 slreportgen.report.Notes 报告器。

notes = slreportgen.report.Notes(source) 为 source 指定的系统创建一个 slreportgen.report.Notes 报告器，并将 Source 属性设置为 source。

示例

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

属性

全部展开

从中提取注释的源，指定为字符串标量、字符向量、句柄或 slreportgen.finder.DiagramResult 对象。源可以是模型、子系统、Stateflow 图、Stateflow 真值表或 Stateflow 状态转移表。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

注释类型，指定为下表中的值之一：

值描述
"Internal"注意内容包含在模型中并保存在 .mldatx 文件中。
"External"注意内容位于模型外部并由 URL 指定。
"Inherited"注意内容源自指定图源的祖先。
"None"该图没有注释。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

数据类型: char | string

是否报告 NoteType 为 "Inherit" 的注释，指定为 true 或 false。报告的注释内容基于父注释 NoteType 的属性。

值描述
"Internal"链接到父级注释内容。
"External"

链接到父注释中指定的外部内容。

"None"内容为空。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

数据类型: logical

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

此示例报告 sldemo_autotrans 模型的注释。此示例报告整体模型的注释。有关报告模型每个子系统的图和注释的示例，请参阅 报告模型注释。

该示例为注释创建了一个章节，并通过在章节中添加 slreportgen.report.Notes 报告器将模型注释包含在该章节中。

model = "sldemo_autotrans";
open_system(model);

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

rpt = slreportgen.report.Report(model + "_Notes_Report","pdf");
open(rpt);

ch = Chapter(Title=(model+" Notes"));
notes = Notes(model);
add(ch,notes);
add(rpt,ch);

close(rpt);
rptview(rpt);

提示

版本历史记录

在 R2020a 中推出

另请参阅

| |

主题