主要内容

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

slreportgen.utils.HierarchyNumber 类

命名空间: slreportgen.utils

生成代表子系统在模型层次结构中位置的数字

自 R2021b 起

描述

使用 slreportgen.utils.HierarchyNumber 类的对象生成表示子系统在模型层次结构中的位置的数字。您可以使用数字来标记报告元素,例如章节标题。

slreportgen.utils.HierarchyNumber 类是 handle 类。

类属性

HandleCompatible
true

有关类属性的信息,请参阅类属性

创建对象

描述

hierarchyNumberObj = slreportgen.utils.HierarchyNumber(source) 为指定源创建一个层次结构编号对象,并将 Source 属性设置为 source

如果将源指定为 Simulink® 模型,则 HierarchyNumber 对象将使用模型中所有未注释的 Simulink 子系统和 Stateflow® 图来生成模型层次结构编号。否则,该对象将使用您指定的自定义子系统列表。例如,要生成模型中 Stateflow 图的层次结构编号,请指定子系统路径列表。

示例

属性

全部展开

模型或子系统,指定为以下值之一:

  • 包含打开或加载的模型名称的字符向量或字符串标量

  • 打开或加载模型的句柄

  • 子系统路径的字符串数组

  • 由子系统路径或句柄组成的元胞数组

属性:

SetAccess
私有

方法

全部展开

示例

全部折叠

slreportgen.utils.HierarchyNumber 模型创建一个 f14 对象,并生成代表 Aircraft Dynamics Model 子系统在模型层次结构中的位置的数字。

modelName = "f14";
load_system(modelName);
hierNumberObj = slreportgen.utils.HierarchyNumber(modelName);
hierNumber = generateHierarchyNumber(hierNumberObj, ...
    "f14/Aircraft Dynamics Model")
hierNumber = 
"1.1"

此示例为模型中每个图生成层次结构编号,并使用与该图相对应的报告节标题中的编号。

导入命名空间,这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*;
import mlreportgen.report.*;
import slreportgen.finder.*;
import slreportgen.utils.*;

加载模型。

model = "f14";
load_system(model);

创建报告。关闭报告节的编号。

rpt = Report("output","pdf");
open(rpt);
mlreportgen.report.Section.number(rpt,false);

创建目录并将其添加到报告中。

toc = TableOfContents();
append(rpt,toc);

创建一个章节并打开章节编号。

chapter = Chapter(model + " Model");
chapter.Numbered = true;

为模型创建一个图查找器和一个 HierarchyNumber 对象。

finder = DiagramFinder(model);
hierNumberObj = HierarchyNumber(model);

对于找到的每个图,生成代表该图在模型层次结构中的相对位置的数字。为图创建一个节并在标题中使用生成的数字。关闭默认章节编号。将该节附加到章节中。

while hasNext(finder)
    result = next(finder);
    hierNumber = hierNumberObj.generateHierarchyNumber(result.Path);
    title = strcat (hierNumber + " " + result.Name);
    section = Section(title);
    section.Numbered = false;
    append(chapter, section);
end

将该章节附加到报告中。

append(rpt,chapter);

关闭并查看报告。

close(rpt);
rptview(rpt);

以下是生成的目录:

版本历史记录

在 R2021b 中推出