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

slreportgen.report.DataDictionary 类

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

Simulink 数据字典报告器

全页展开

描述

使用 slreportgen.report.DataDictionary 类的对象来报告 Simulink® 数据字典。创建一个 DataDictionary 对象来报告特定的数据字典。或者，使用 slreportgen.finder.DataDictionaryFinder 对象查找数据字典并使用 slreportgen.finder.DataDictionaryResult 对象的 getReporter 方法返回结果的报告器。

注意

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

slreportgen.report.DataDictionary 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

reporter = slreportgen.report.DataDictionary 根据默认模板创建一个 DataDictionary 报告器对象。使用报告器属性来指定数据字典和报告选项。您必须指定要报告的数据字典。向报告中添加空的数据字典报告器对象会产生错误。

reporter = slreportgen.report.DataDictionary(dictionaryName) 创建一个 DataDictionary 报告器对象，并将 Dictionary 属性设置为指定的数据字典。使用报告器属性来指定报告选项。

示例

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

属性

全部展开

要报告的数据字典，指定为字符向量或字符串标量，包含 MATLAB® 路径上的字典文件名或数据字典的路径和文件名。该路径可以是相对的，也可以是绝对的。

示例: "sldemo_fuelsys_dd.sldd"

示例: "myDictionaries/myDataDictionary.sldd"

属性：

GetAccess
公共
SetAccess
公共

要报告摘要表中每个数据字典条目的属性，指定为字符串数组或字符向量元胞数组。有效属性为：

  • Name

  • Value

  • Class

  • LastModified

  • LastModifiedBy

  • Status

  • DataSource

如果数据类型是数字标量、逻辑标量、字符串标量或字符向量，则 Value 条目包含该值。否则，Value 条目是查看详细信息。

示例: ["Name" "Value" "Class" "LastModified" "LastModifiedBy" "Status" "DataSource"]

示例: {'Name' 'Value' 'Class'}

属性：

GetAccess
公共
SetAccess
公共

是否报告数据字典的设计数据节，指定为 true 或 false。

属性：

GetAccess
公共
SetAccess
公共

数据类型: logical

是否报告数据字典的配置节，指定为 true 或 false。

属性：

GetAccess
公共
SetAccess
公共

数据类型: logical

是否报告数据字典的其他数据节，指定为 true 或 false。

属性：

GetAccess
公共
SetAccess
公共

数据类型: logical

是否包含本报告器报告的字典所引用的字典，指定为 true 或 false。ReferencedDictionaryPolicy 属性决定如何报告引用的字典。

属性：

GetAccess
公共
SetAccess
公共

数据类型: logical

显示报告引用字典的策略，指定为以下值之一：

  • "SameTable" - 将引用的字典条目与主字典条目报告在同一表中。详细信息按照其在摘要表中出现的顺序显示。该值是默认值。

  • "SeparateTables" - 为每个引用的字典创建一个单独的表格。引用字典摘要表在主摘要表之后立即显示。引用的字典详细信息报告器显示在主字典详细信息报告器之后。

  • "List" -报告引用词典的列表。列表项链接到单独的数据字典报告器。仅当您将所引用词典的报告器添加到此报告时，链接才有效。该列表出现在“设计数据”节，紧接着字典摘要表之后。字典摘要表不包含所引用的字典条目。没有报告引用字典条目的详细信息。

属性：

GetAccess
公共
SetAccess
公共

用于过滤的数据字典条目，指定为函数句柄、字符串标量或字符向量。如果 EntryFilterFcn 为空，则报告将包括所有数据字典条目。

如果您指定了一个函数句柄，则与该句柄关联的函数必须：

  • 接受以下参量：

  • 返回 true 以从报告中过滤指定条目，或返回 false 以将该条目包含在报告中。

有关示例，请参阅使用函数句柄过滤数据字典条目。

如果您指定一个字符串标量或字符向量，它必须包含一个表达式。表达式：

  • 可以使用变量 entryObject 和 entryValue

  • 必须将变量 isFiltered 设置为 true 才能从报告中过滤出指定的条目，或者将变量设置为 false 才能将条目包含在报告中

有关示例，请参阅使用字符串标量过滤数据字典条目。

属性：

GetAccess
公共
SetAccess
公共

条目摘要表的格式化程序，指定为 mlreportgen.report.BaseTable 对象。该属性的默认值是 BaseTable 对象，其 TableStyleName 属性设置为 DataDictionaryTable 样式，该样式在 DataDictionary 报告器的默认模板中定义。要自定义表的外观，请修改默认 BaseTable 对象的属性或用自定义的 BaseTable 报告器替换该对象。如果向 Title 属性添加内容，则该内容会出现在生成的报告中的表标题前面。

属性：

GetAccess
公共
SetAccess
公共

用于报告数据字典的设计数据和 其他数据节中的条目值的详细信息的格式化程序，指定为 mlreportgen.report.MATLABVariable 对象。该属性的默认值是一个具有默认属性值的 MATLABVariable 对象。要自定义条目详细信息的外观，请修改默认 MATLABVariable 对象的属性或用您自己的 MATLABVariable 报告器替换该对象。MATLABVariable 报告器的 Variable、Location 和 LinkTarget 属性被忽略。

属性：

GetAccess
公共
SetAccess
公共

用于报告数据字典的配置节中的条目值的详细信息的格式化程序，指定为 slreportgen.report.ModelConfiguration 对象。该属性的默认值是一个具有默认属性值的 ModelConfiguration 对象。要自定义条目详细信息的外观，请修改默认对象的属性或将其替换为您自己的 ModelConfiguration 对象。报告器的 Model 和 LinkTarget 属性被忽略。

属性：

GetAccess
公共
SetAccess
公共

引用字典列表的列表格式化程序，指定为 mlreportgen.dom.UnorderedList 对象或 mlreportgen.dom.OrderedList 对象。当 ReferencedDictionaryPolicy 属性设置为 "List" 时，使用列表格式化程序。UnorderedList 或 OrderedList 对象不能包含列表项。

该属性的默认值是 UnorderedList 对象，其 StyleName 属性设置为 DataDictionaryList 样式，该样式在 DataDictionary 报告器的默认模板中定义。要自定义列表的外观，请修改默认 UnorderedList 对象的属性，或将该对象替换为您自己的 UnorderedList 或 OrderedList 对象。

属性：

GetAccess
公共
SetAccess
公共

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

此示例展示了如何使用 slreportgen.report.DataDictionary 类对象来报告 Simulink 数据字典。

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

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

创建 Simulink 报告。

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

指定数据字典的名称 sldemo_fuelsys_dd。

ddName = "sldemo_fuelsys_dd.sldd";

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

ch = Chapter(ddName);

为数据字典创建一个报告器。 

rptr = DataDictionary(ddName);

将报告器附加到章节，将章节附加到报告。

append(ch,rptr);
append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

此示例使用:

打开实时脚本

此示例通过将 EntryFilterFcn 属性指定为函数句柄，展示了如何过滤数据字典条目中的 Simulink.Parameter 对象。

创建 Simulink 报告。

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

指定数据字典的名称 sldemo_fuelsys_dd。

ddName = "sldemo_fuelsys_dd.sldd";

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

ch = mlreportgen.report.Chapter(ddName);

为数据字典创建一个报告器。 

rptr = slreportgen.report.DataDictionary(ddName);

将 EntryFilterFcn 属性指定为名为 filterFcnHandle 的函数句柄，该函数句柄过滤 Simulink.Parameter 对象的条目。

filterFcnHandle = @(entryObject, entryValue) ...
    isa(entryValue,"Simulink.Parameter");
rptr.EntryFilterFcn = filterFcnHandle;

将报告器附加到章节，将章节附加到报告。

append(ch,rptr);
append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

此示例使用:

打开实时脚本

此示例通过将 EntryFilterFcn 属性指定为字符串来过滤 Simulink.Bus 对象的条目。

创建 Simulink 报告。

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

指定数据字典的名称 sldemo_fuelsys_dd。

ddName = "sldemo_fuelsys_dd.sldd";

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

ch = mlreportgen.report.Chapter(ddName);

为数据字典创建一个报告器。 

rptr = slreportgen.report.DataDictionary(ddName);

将 EntryFilterFcn 属性指定为一个字符串，以过滤 Simulink.Bus 对象的条目。字符串必须包含一个表达式，该表达式设置名为 isFiltered 的变量的值。

filterStr = "isFiltered = isa(entryValue,'Simulink.Bus');";
rptr.EntryFilterFcn = filterStr;

将报告器附加到章节，将章节附加到报告。

append(ch,rptr);
append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

版本历史记录

在 R2020b 中推出

另请参阅

| |

主题