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

slreportgen.report.SystemHierarchy 类

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

系统层次报告器

全页展开

描述

创建一个系统层次结构报告器，在报告中生成 Simulink® 模型或子系统的子系统的嵌套列表。

注意

要在报告中使用系统层次结构报告器，您必须使用 slreportgen.report.Report 类或子类创建报告。

slreportgen.report.SystemHierarchy 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

rptr = slreportgen.report.SystemHierarchy 根据默认模板创建一个空的系统层次结构报告器。使用报告器属性自定义生成列表的内容和格式。在将报告器添加到报告之前，您必须在报告器的 Source 属性中指定模型或子系统。在报告中添加空的报告器会产生错误。

rptr = slreportgen.report.SystemHierarchy(source) 为 source 指定的模型或子系统创建系统层次结构报告器。请参阅 Source 属性。

示例

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

属性

全部展开

Simulink 模型或子系统，指定为包含模型或子系统路径的字符向量或字符串标量，或模型或子系统的句柄。

属性：

NonCopyable
true

生成列表中包含的源子系统祖先的最大级别数，指定为非负整数标量。例如，如果 MaxAncestorLevel 是 2，则列表包括源和最多两级祖先。如果 MaxAncestorLevel 是 Inf（默认值），则列表包含所有祖先。如果 MaxAncestorLevel 为零，则列表不包括祖先。

数据类型: double

生成列表中包含的源模型或子系统的后代最大级别数，指定为非负整数标量。例如，如果 MaxDescendantLevel 是 2，则列表包括源和最多两级后代。如果 MaxDescendantLevel 是 Inf（默认值），则列表包含所有后代。如果 MaxDescendantLevel 为零，则列表不包括后代。

数据类型: double

是否在生成的列表中包含源子系统的对等体，指定为 true 或 false。

数据类型: logical

是否在生成的列表中强调源模型或子系统，指定为 true 或 false。如果 EmphasizeSource 是 true，则源模型或子系统的名称将根据 TextFormatter 属性进行格式化。否则，其格式将与列表中的其他项相同。

数据类型: logical

列表格式化程序，用于格式化生成的列表，指定为 mlreportgen.dom.UnorderedList 对象或 mlreportgen.dom.OrderedList 对象。该属性的默认值是 mlreportgen.dom.UnorderedList 的对象。要自定义列表格式，请修改列表对象属性或将列表对象替换为不包含列表项的自定义列表对象。

文本格式化程序对象，用于格式化生成列表中的源模型或子系统的名称，指定为 mlreportgen.dom.Text 对象。仅当 EmphasizeSource 属性为 true 时，此属性才适用。SourceTextFormatter 属性的初始值是 mlreportgen.dom.Text 对象，其 Bold 和 Italic 属性设置为 true。要自定义生成列表中名称的外观，请修改 mlreportgen.dom.Text 对象属性或将该对象替换为自定义的 mlreportgen.dom.Text 对象。如果向默认或替换文本对象添加文本，则该文本将出现在生成的报告中的源名称前面。

源系统的后代生成列表是否包含封装子系统，指定为 true 或 false。如果 IncludeMaskedSubsystems 是 true，则列表包括封装子系统及其后代子系统，只要源子系统下方的级别数小于或等于 MaxDescendantLevel 属性的值。

为了使系统层次结构报告器能够将封装子系统链接到报告中的相应图，请在图报告器中将 MaskedSystemLinkPolicy 属性设置为 'system'。

数据类型: logical

源系统的后代生成列表是否包含引用模型，指定为 true 或 false。如果 IncludeReferencedModels 是 true，则列表包括引用模型及其后代子系统，只要源子系统下方的级别数小于或等于 MaxDescendantLevel 属性的值。

数据类型: logical

源系统的后代生成列表是否包含引用的子系统，指定为 true 或 false。如果 IncludeReferencedSubsystems 是 true，则列表包括引用的子系统及其后代子系统，只要源子系统下方的级别数小于或等于 MaxDescendantLevel 属性的值。

数据类型: logical

源系统生成的后代列表是否包含链接到 Simulink 库子系统的子系统，指定为 true 或 false。仅当以下所有条件都成立时，列表才会包含链接子系统或其后代子系统之一：

  • IncludeSimulinkLibraryLinks 的值是 true。

  • 子系统未被封装，或者子系统被封装并且 IncludeMaskedSubsystems 属性的值为 true。

  • 源子系统之下的级别数小于或等于 MaxDescendantLevel 属性的值。

数据类型: logical

源系统的后代生成列表是否包含链接到用户定义的库子系统的子系统，指定为 true 或 false。仅当以下所有条件都成立时，列表才会包含链接子系统或其后代子系统之一：

  • IncludeUserLibraryLinks 的值是 true。

  • 子系统未被封装，或者子系统被封装并且 IncludeMaskedSubsystems 属性的值为 true。

  • 源子系统之下的级别数小于或等于 MaxDescendantLevel 属性的值。

数据类型: logical

要包含在源系统的后代生成的列表中的变体模块的变体，指定为以下值之一：

值描述
"Active"活动变体
"All"所有变体
"ActivePlusCode"活跃变体和代码变体

仅当源子系统之下的级别数小于或等于 MaxDescendantLevel 属性的值时，列表才会包含变体。

数据类型: char | string

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

通过在报告生成程序中添加 sldemo_fuelsys 报告器，将 slreportgen.report.SystemHierarchy 模型的系统层次结构包含在报告中。通过添加 slreportgen.finder.DiagramFinder 对象来生成模型图。系统层次结构报告器从嵌套列表中的子系统生成到相应图的链接。

导入 API 包。

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

加载模型。

model = "sldemo_fuelsys";
load_system(model);

创建报告。

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

创建章节报告器。

chapter = Chapter("System Hierarchy for the " + model + " Model");

为模型创建一个系统层次结构报告器。

rptr = SystemHierarchy(model);

将“系统层次结构”报告器添加到该章节。然后将章节添加到报告中。

add(chapter, rptr);
add(rpt, chapter);

查找子系统的示意图。

finder = slreportgen.finder.DiagramFinder(model);
while hasNext(finder)
    result = next(finder);
    ch = Chapter(result.Name);
    add(ch, result);
    add(rpt, ch);
end

关闭并查看输出报告。

close(rpt);
close_system(model);
rptview(rpt);

在生成的报告中，系统层次结构列出了sldemo_fuelsys模型下的子系统。

System hierarchy listing the subsystems under the sldemo_fuelsys model. Subsystems include Dashboard, Engine Gas Dynamics, To Controller, To Plant, and fuel_rate_control.

要查看与子系统对应的图，点击列表中的子系统。

版本历史记录

在 R2019b 中推出

另请参阅

主题