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

slreportgen.report.SummaryTable 类

命名空间: slreportgen.report

查找器结果摘要表报告器

自 R2022a 起

全页展开

描述

使用 slreportgen.report.SummaryTable 类的对象通过查找器对象汇总从 Simulink® 模型获得的搜索结果。

注意

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

slreportgen.report.SummaryTable 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

summaryTableRptr = slreportgen.report.SummaryTable 为未指定的一组查找器结果创建一个摘要表。

注意

向报告中添加具有未指定结果的 Simulink 摘要表报告器会导致错误。

summaryTableRptr = slreportgen.report.SummaryTable(finderResults) 为数组 finderResults 中的查找器结果对象创建一个摘要表报告器，并将 FinderResults 属性设置为 finderResults。

摘要表为每个结果包含一行，其条目包含找到的对象的属性。默认情况下，报告的属性取决于结果对象类型。使用摘要表报告器 Properties 属性来自定义要报告的属性集。

示例

summaryTableRptr = slreportgen.report.SummaryTable(Name=Value) 使用名称-值参量设置属性。以任意顺序指定多个名称-值参量。

属性

全部展开

要报告的查找器结果对象，指定为 查找器结果类 对象数组（例如 slreportgen.report.FunctionReferenceResult 或 slreportgen.report.SignalResult）。

属性：

GetAccess
公共
SetAccess
公共

摘要表的标题，指定为字符串、字符向量或 DOM 对象。默认情况下，该属性为空，报告器使用 getDefaultSummaryTableTitle 方法为 finderResults 指定的查找器结果对象创建表标题。

将此属性指定为字符向量或字符串标量将在生成的报告中创建一个 mlreportgen.dom.Paragraph 对象，其 Style 属性设置为 'SummaryTableTitleParagraph'。

属性：

GetAccess
公共
SetAccess
公共

要报告的结果类的属性，指定为字符串标量数组或字符向量元胞数组。

如果该属性为空，报告器将使用 getDefaultSummaryProperties 中指定的查找器结果对象的 finderResults 方法来确定要报告哪些结果对象属性。

使用 getPropertyValues 指定的查找器结果对象的 finderResults 方法来识别可以添加到摘要表中的属性。

属性：

GetAccess
公共
SetAccess
公共

是否根据结果对象的 Type 属性（指定为 true 或 false）为查找器结果对象创建单独的摘要表。

属性：

GetAccess
公共
SetAccess
公共

是否将摘要表中每个对象的 Name 属性链接到相应的报告器对象，指定为 true 或 false。

属性：

GetAccess
公共
SetAccess
公共

是否在摘要表中包含空查找器结果对象属性的列，指定为 false 或 true。

属性：

GetAccess
公共
SetAccess
公共

表格报告器格式化程序类型，指定为 mlreportgen.report.BaseTable 对象。该属性的默认值是 BaseTable 对象，其 TableStyleName 属性设置为 FunctionReferenceTable 样式，该样式在 FunctionReference 报告器的默认模板中定义。

要自定义摘要表的外观，请自定义默认报告器或将其替换为自定义的 BaseTable 报告器。

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

此示例显示如何将代表 Simulink® 模型中命名信号的查找器结果摘要表添加到报告。

创建 PDF 报告并加载所需模型

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

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

% Open the model to report on
model_name = "sf_car";
load_system(model_name);

% Create a chapter for the Summary Table Reporter
titleStr = "Summary Table for Named Signals in "+model_name;
add(rpt,TitlePage(Title=titleStr,Author=""));

创建一个 SignalFinder 对象来查找模型中的所有命名信号。

sigFinder = slreportgen.finder.SignalFinder(model_name);
sigFinder.IncludeInternalSignals = true;
sigFinder.IncludeUnnamedSignals = false;
results = find(sigFinder);

为查找器对象的结果创建一个摘要表报告器。

reporter = slreportgen.report.SummaryTable(results);
reporter.Properties = ["Name","Source","DataType","Dimensions"];
reporter.Title = "Named Signals";
add(rpt,reporter);
close(rpt);
rptview(rpt);
close_system(model_name);

详细信息

全部展开

版本历史记录

在 R2022a 中推出

另请参阅

| | | | | | |