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

slreportgen.report.TestSequence 类

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

Test Sequence 模块报告器

全页展开

描述

使用 slreportgen.report.TestSequence 类的对象来报告 Simulink® Test Sequence 模块。在 Simulink 模型中使用 Test Sequence 模块需要 Simulink Test™。

默认情况下，TestSequence 报告器会生成：

  • 所有符号的属性表--输入、输出、本地、常量、参数和数据存储内存

  • 步骤层次的嵌套列表

  • 每个步骤的详细信息，包括步骤描述、When 条件、操作语句以及转移条件和后续步骤的表格

如果 Test Sequence 模块使用场景，则 TestSequence 报告器会在参数表中包含场景参数，并在步骤层次结构中包含每个场景的列表。在报告中，场景通过场景图标来识别。活动场景也通过单词 Active 和后跟活动场景图标来标识。例如：

Scenario 2 (Active)

当活动场景在工作区中受到控制时，报告器会在报告中添加注释。在这种情况下，报告中未标识出活动场景。

使用 TestSequence 报告器属性来过滤内容并自定义内容格式。

注意

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

slreportgen.report.TestSequence 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

reporter = slreportgen.report.TestSequence 根据默认模板创建一个空的 TestSequence 报告器对象。您必须通过设置 Object 属性来指定要报告的 Test Sequence 模块。使用其他属性来指定报告选项。

reporter = slreportgen.report.TestSequence(testSeqObject) 创建一个 TestSequence 报告器，并将 Object 属性设置为指定的 Test Sequence 模块。

示例

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

属性

全部展开

要报告的 Test Sequence 模块，指定为以下类型的值之一：

是否在报告中包含符号，指定为 true 或 false。如果 IncludeSymbols 是 true，则报告包含符号的属性表。在输入和输出符号属性表中，符号按端口号排序。在本地、常量、参数和数据存储内存表中，符号按符号名称排序。

如果模型在报告生成之前进行了编译，则属性表中的值是编译后的值。否则，属性值是编译前的值，并且符号节末尾的注释指出模型未经编译。默认情况下，模型在报告生成期间进行编译。您可以通过设置包含此报告器的 slreportgen.report.Report 对象的 CompileModelBeforeReporting 属性来控制是否在报告生成期间编译模型。

数据类型: logical

是否包含步骤层次结构，指定为 true 或 false。如果 IncludeStepHierarchy 是 true，则报告将步骤层次结构作为嵌套列表包含在内。列表中的步骤名称链接到报告中对应的步骤内容。

数据类型: logical

是否包含步骤内容，指定为 true 或 false。如果 IncludeStepContent 是 true，则报告包含每个步骤的内容。在报告的步骤内容中，步骤名称链接到报告中的步骤层次结构。您可以使用 IncludeStepDescription、IncludeStepWhenCondition、IncludeStepAction、IncludeStepTransitions 和 IncludeStepRequirements 属性来过滤报告的步骤内容。

数据类型: logical

是否在报告的步骤内容中包含步骤描述，指定为 true 或 false。

数据类型: logical

是否在步骤报告的内容中包含步骤 When 条件，指定为 true 或 false。When 条件是激活 When 分解子步骤的条件。

数据类型: logical

是否在步骤报告的内容中包含步骤操作，指定为 true 或 false。

数据类型: logical

是否在步骤报告的内容中包含步骤转移表，指定为 true 或 false。步骤转移表包含转换条件和后续步骤。

数据类型: logical

是否在步骤报告的内容中包含步骤需求的链接，指定为 true 或 false。链接到步骤需求需要 Requirements Toolbox™。

数据类型: logical

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

步骤层次结构列表的格式化程序，指定为 mlreportgen.dom.UnorderedList 对象或 mlreportgen.dom.OrderedList 对象。UnorderedList 或 OrderedList 对象不能包含列表项。

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

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

此示例显示如何使用 slreportgen.report.TestSequence 对象来报告 Test Sequence 模块。

导入这些包，这样您就不必使用长而完全限定的类名。

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

创建 PDF 类型的 Simulink® 报告生成器报告。

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

加载具有测试序列的模型。

model_name = "slrgex_sltestTestSequenceDebouncerExample";
load_system(model_name);
testSeqObj = strcat(model_name,"/Debouncer_Test");

为 Test Sequence 模块创建一个章节。

chapter = Chapter(testSeqObj);

为 Test Sequence 模块创建一个报告器。

rptr = TestSequence(testSeqObj);

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

append(chapter,rptr);
append(rpt,chapter);

关闭报告和模型并查看报告。

close(rpt);
close_system(model_name);
rptview(rpt);

版本历史记录

在 R2020b 中推出

另请参阅

(Simulink Test)

主题