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

slreportgen.finder.DataDictionaryFinder 类

命名空间: slreportgen.finder
超类: mlreportgen.finder.Finder

查找数据字典

全页展开

描述

使用 slreportgen.finder.DataDictionaryFinder 类的对象来查找 Simulink® 数据字典。

slreportgen.finder.DataDictionaryFinder 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

finder = slreportgen.finder.DataDictionaryFinder 创建数据字典查找器并将 Container 属性设置为 'MATLABPath'。

您可以通过设置查找器的属性来限制搜索。使用查找器的方法执行搜索。

注意

此查找器提供了以下选项来获取搜索结果：

  • 要将搜索结果作为数组返回，请使用 find 方法。将结果直接添加到报告中或在 for 循环中处理结果。

  • 要逐个迭代结果，请在 while 循环中使用 hasNext 和 next 方法。

这两个选项在性能上都没有优势。

finder = slreportgen.finder.DataDictionaryFinder(searchFolder) 创建一个数据字典查找器，并将 Container 属性设置为 searchFolder 指定的文件夹。

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

属性

全部展开

用于搜索数据字典的文件夹，指定为字符串数组、字符向量或字符向量元胞数组。字符串和字符向量可以包含 * 和 ** 通配符。** 通配符旁边的字符必须是文件分隔符。例如，要查找 exampleFolder 文件夹及其子文件夹中的所有数据字典，请将 Container 设置为 "exampleFolder\**"。如果将 Container 设置为 'MATLABPath'，则查找器将在当前文件夹和 MATLAB® 路径上的所有文件夹中搜索数据字典。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string | cell

数据字典用于查找，指定为字符向量或字符串标量。Name 属性值可以包含 * 通配符。例如，要查找以 sldemo_fuelsys_dd 开头的所有数据字典，请将 Name 属性设置为 "sldemo_fuelsys_dd*"。此属性中指定的名称或表达式不得有文件扩展名或扩展名 .sldd。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

要查找的数据字典的属性，指定为名称-值参量的元胞数组。使用 Properties 属性通过数据字典属性过滤查找器结果。查找器在 Container 属性指定的文件夹中搜索名称与 Name 属性匹配且具有指定属性值的数据字典。有关数据字典属性，请参阅 Simulink.data.Dictionary。例如，要仅返回有权访问基础工作区的数据字典，请将 Properties 设置为 {'HasAccessToBaseWorkspace',true}。

属性：

GetAccess
公共
SetAccess
公共

数据类型: cell

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

要报告数据字典，请创建一个 slreportgen.DataDictionaryFinder 对象。使用对象属性来约束搜索和获取结果的方法。

导入 MATLAB 报告和 Simulink 报告 API 包，这样您就不必使用长而完全限定的类名。

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

创建一份 Simulink 报告并将目录附加到报告中。

rpt = slreportgen.report.Report("MyReport","html-file");
append(rpt,TableOfContents);

创建一个 Simulink 数据字典查找器来搜索整个 MATLAB 路径。

f = DataDictionaryFinder();

限制查找器仅查找名称中包含字符串control的数据字典。

f.Name = "*control*";

为数据字典创建一个章节。 

ch = Chapter("Data Dictionaries");

对于每本找到的字典，创建一个部分并将其附加到章节中。

while hasNext(f)
    result = next(f);
    s = Section(result.Name);
    append(s,result);
    append(ch,s);
end

将该章节附加到报告中。关闭并查看报告。

append(rpt,ch);
close(rpt);
rptview(rpt);

版本历史记录

在 R2020b 中推出

另请参阅

|

主题