sltest.testmanager.TestResultReport 类

命名空间: sltest.testmanager

定制生成的结果报告

全页展开

描述

sltest.testmanager.TestResultReport 是一个使您能够自定义测试管理器的结果报告生成的类。您可以派生类并覆盖各种方法来定制您的报告。通过自定义方法，您可以更改报告标题、图表、表格、标题、图标等。

有关自定义报告的更多信息和示例，请参阅自定义测试结果报告。

sltest.testmanager.TestResultReport 类是 handle 类。

类属性

HandleCompatible true

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

创建对象

Obj = sltest.testmanager.TestResultReport(resultObjects,reportFilePath) 创建报告生成对象。

要使用此类，您必须从该类继承。使用以下代码作为类定义代码的第一行来从该类继承。

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    %
    % Report customization code here
    %
end

输入参量

全部展开

`resultObjects` — 结果集对象
对象

从结果集对象获取结果，指定为 sltest.testmanager.ResultSet 对象。

`reportFilePath` — 生成报告的文件名和路径
字符向量

生成的报告的文件名和路径。文件路径必须具有 pdf、docx 或 zip 文件扩展名，这些是唯一支持的文件类型。

示例: 'C:\MATLAB\Report.pdf'

属性

全部展开

`AuthorName` — 作者姓名
空特征向量 (默认)

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`BodyFontColor` — 正文段落字体颜色
`'Black'` (默认) | 字符向量

正文段落文本字体颜色，指定为字符向量。

示例: 'Red'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`BodyFontName` — 正文段落字体样式名称
`'Arial'` (默认) | 字符向量

正文段落文本字体样式名称，指定为字符向量。

示例: 'Times New Roman'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`BodyFontSize` — 正文段落字体大小
`'12pt'` (默认) | 字符向量

正文段落文本字体大小，以点为单位指定为字符向量。

示例: '14pt'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ChapterIndent` — 一级压痕宽度
`'3mm'` (默认) | 字符向量

第一级部分缩进宽度，以毫米为单位指定为字符向量。

示例: '5mm'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ChapterIndentL2` — 二级压痕宽度
`'6mm'` (默认) | 字符向量

第二级部分缩进宽度，以毫米为单位指定为字符向量。

示例: '8mm'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ChapterIndentL3` — 三级压痕宽度
`'8mm'` (默认) | 字符向量

第三级部分缩进宽度，以毫米为单位指定为字符向量。

示例: '10mm'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`CustomTemplateFile` — 模板文件名和路径
空特征向量 (默认)

用于报告定制的 Microsoft^® Word 模板文件的文件名和路径，指定为字符向量。有关使用模板文件的更多信息，请参阅使用模板生成报告。仅当您拥有 MATLAB^® Report Generator™ 许可证时，此参量的使用才有效。

示例: 'C:\MATLAB\CustomReportTemplate.dotx'

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`HeadingFontColor` — 部分标题字体颜色
`'Black'` (默认) | 字符向量

章节标题文本字体颜色，指定为字符向量。

示例: 'Blue'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`HeadingFontName` — 节标题字体样式名称
`'Arial'` (默认) | 字符向量

章节标题文本字体样式名称，指定为字符向量。

示例: 'Times New Roman'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`HeadingFontSize` — 章节标题字体大小
`'14pt'` (默认) | 字符向量

章节标题文本字体颜色，以点为单位指定为字符向量。

示例: '16pt'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileOutcomeDisabled` — 已禁用的测试结果图标
空特征向量 (默认)

禁用测试结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\disabled_test_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileOutcomeFailed` — 失败的测试结果图标
空特征向量 (默认)

失败测试结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\failed_test_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileOutcomeIncomplete` — 不完整的测试结果图标
空特征向量 (默认)

不完整测试结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\incomplete_test_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileOutcomeMisaligned` — 测试结果图标未对齐
空特征向量 (默认)

未对齐测试结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\misaligned_test_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileOutcomePassed` — 通过的测试结果图标
空特征向量 (默认)

已通过的测试结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\passed_test_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileTestCaseResult` — 测试用例结果图标
空特征向量 (默认)

测试用例结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\test_case_result_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileTestFileResult` — 测试文件结果图标
空特征向量 (默认)

测试文件结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\test_file_result_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileTestIterationResult` — 迭代结果图标
空特征向量 (默认)

迭代结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\iteration_result_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconFileTestSuiteResult` — 测试套件结果图标
空特征向量 (默认)

测试套件结果的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\test_suite_result_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconModelReference` — 模型参考图标
空特征向量 (默认)

覆盖率报告中模型引用的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\model_reference_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IconTopLevelModel` — 顶层模型图标
空特征向量 (默认)

覆盖率报告中顶层模型的图标图像的文件名和路径，指定为字符向量。指定的图标文件替换了默认的图标图像。图标图像缩小到 16x16 像素。

示例: 'C:\MATLAB\top_level_model_icon.png'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeComparisonSignalPlots` — 包括比较信号图
`false` (默认) | `true`

在报告中包含信号比较图，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeCoverageResult` — 包括覆盖率结果
`false` (默认) | `true`

在报告中包含覆盖率结果，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeErrorMessages` — 包含错误消息
`true` (默认) | `false`

在报告中包含错误消息，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeMWVersion` — 包含 MATLAB 版本
`true` (默认) | `false`

包括用于在报告中运行测试的 MATLAB 版本，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeSimulationMetaData` — 包括仿真元数据
`false` (默认) | `true`

在报告中包含仿真元数据，指定为 true 或 false。元数据包括 Simulink^® 模型、模型版本、模型路径、仿真模式、覆盖 SIL 或 PIL 模式、配置集、变体配置、求解器名称和类型、最大步长、开始和停止时间、校验和、用户 ID、机器名称、平台以及 Simulink 版本和发布版。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeSimulationSignalPlots` — 包括仿真信号图
`false` (默认) | `true`

在报告中包含仿真信号输出图，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeTestRequirement` — 包括测试需求
`true` (默认) | `false`

在报告中包含与测试文件、测试套件或测试用例相关的测试需求，指定为 true 或 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`IncludeTestResults` — 包括全部或部分测试结果
`2` (默认) | `0` | `1`

在报告中包括全部或部分测试结果。您可以选择所有通过和失败的结果（指定为值 0），仅选择通过的结果（指定为值 1），或者仅选择失败的结果（指定为值 2）。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`LaunchReport` — 完成后打开报告
`true` (默认) | `false`

报告生成完成后打开报告，指定为布尔值 true 或不打开报告 false。

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ReportTitle` — 报告标题
空特征向量 (默认)

报告标题，指定为字符向量

示例: 'Test Case Report'

属性：

`SetAccess`	`public`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`SectionSpacing` — 各部分之间的间距
`'2mm'` (默认) | 字符向量

各部分之间的间距，以毫米为单位指定为字符向量。

示例: '5mm'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`SignalPlotHeight` — 地模块高度
`'600px'` (默认) | 字符向量

绘图高度，以像素为单位指定为字符向量。

示例: '500px'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`SignalPlotWidth` — 地模块宽度
`'500px'` (默认) | 字符向量

绘图宽度，以像素为单位指定为字符向量。

示例: '400px'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TableFontColor` — 表格字体颜色
`'Black'` (默认) | 字符向量

表格字体颜色，指定为字符向量。

示例: 'Blue'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TableFontName` — 表格字体样式名称
`'Arial'` (默认) | 字符向量

表字体样式名称，指定为字符向量。

示例: 'Times New Roman'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TableFontSize` — 表格字体大小
`'7.5pt'` (默认) | 字符向量

表格字体大小，以点为单位指定为字符向量。

示例: '10pt'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TitleFontColor` — 标题字体颜色
`'Black'` (默认) | 字符向量

标题字体颜色，指定为字符向量。

示例: 'Blue'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TitleFontName` — 标题字体样式名称
`'Arial'` (默认) | 字符向量

标题字体样式名称，指定为字符向量。

示例: 'Times New Roman'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TitleFontSize` — 标题字体大小
`'16pt'` (默认) | 字符向量

标题字体大小，以点为单位指定为字符向量。

示例: '20pt'

属性：

`SetAccess`	`protected`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

方法

全部展开

公共方法

`genTableRowsForResultMetaInfo`	生成测试结果元数据表
`addReportBody`	添加报告主体
`addReportTOC`	添加报告目录
`addTitlePage`	添加报告标题页
`genBaselineInfoTable`	生成基线数据集信息表
`genCoverageTable`	生成覆盖率收集表
`genHyperLinkToToC`	生成目录链接
`genIterationSettingTable`	生成迭代设置表
`genMetadataBlockForTestResult`	生成结果元数据部分
`genParameterOverridesTable`	生成测试用例覆盖表
`genRequirementLinksTable`	生成需求链接表
`genResultSetBlock`	生成结果集部分
`genRunBlockForTestCaseResult`	生成测试用例配置和结果部分
`genSignalSummaryTable`	生成信号输出和比较数据
`genSimulationConfigurationTable`	生成测试用例仿真配置表
`genTableRowsForResultMetaInfo`	生成测试结果元数据表
`genTestCaseResultBlock`	生成测试用例结果部分
`genTestSuiteResultBlock`	生成测试套件结果部分
`layoutReport`	将报告的各个部分合并为一个文档
`plotOneSignalToFile`	将信号图保存到文件

示例

全部折叠

继承类并自定义报告

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    % This custom class used by Test Manager 
    % adds a custom message in the title page

    % Class constructor
    methods
        function this = CustomReport(resultObjects, reportFilePath)
            this@sltest.testmanager.TestResultReport...
               (resultObjects,reportFilePath);
        end
    end

    methods(Access=protected)
        function addTitlePage(obj)
            import mlreportgen.dom.*;

            % Call the superclass method to get the default behavior
            addTitlePage@sltest.testmanager.TestResultReport(obj);

            % Add a custom message
            label = Text('Some custom content can be added here');
            append(obj.TitlePart,label);
        end
    end
end

使用自定义报告类生成报告

% import existing results or use sltest.testmanager.run to run tests
% and collect results
result = sltest.testmanager.importResults('testResults.mldatx');
filePath = 'testreport.zip';
sltest.testmanager.report(result,filePath,...
			'Author','User',...
			'Title','Test',...
			'IncludeMLVersion',true,...
			'IncludeTestResults',int32(0),...
			'CustomReportClass','CustomReport',...
			'LaunchReport',true);

版本历史记录

在 R2016a 中推出

另请参阅

sltest.testmanager.report | sltest.testmanager.ResultSet

sltest.testmanager.TestResultReport 类

描述

类属性

创建对象

输入参量

resultObjects — 结果集对象 对象

reportFilePath — 生成报告的文件名和路径 字符向量

属性

AuthorName — 作者姓名 空特征向量 (默认)

属性：

BodyFontColor — 正文段落字体颜色 'Black' (默认) | 字符向量

属性：

BodyFontName — 正文段落字体样式名称 'Arial' (默认) | 字符向量

属性：

BodyFontSize — 正文段落字体大小 '12pt' (默认) | 字符向量

属性：

ChapterIndent — 一级压痕宽度 '3mm' (默认) | 字符向量

属性：

ChapterIndentL2 — 二级压痕宽度 '6mm' (默认) | 字符向量

属性：

ChapterIndentL3 — 三级压痕宽度 '8mm' (默认) | 字符向量

属性：

CustomTemplateFile — 模板文件名和路径 空特征向量 (默认)

属性：

HeadingFontColor — 部分标题字体颜色 'Black' (默认) | 字符向量

属性：

HeadingFontName — 节标题字体样式名称 'Arial' (默认) | 字符向量

属性：

HeadingFontSize — 章节标题字体大小 '14pt' (默认) | 字符向量

属性：

IconFileOutcomeDisabled — 已禁用的测试结果图标 空特征向量 (默认)

属性：

IconFileOutcomeFailed — 失败的测试结果图标 空特征向量 (默认)

属性：

IconFileOutcomeIncomplete — 不完整的测试结果图标 空特征向量 (默认)

属性：

IconFileOutcomeMisaligned — 测试结果图标未对齐 空特征向量 (默认)

属性：

IconFileOutcomePassed — 通过的测试结果图标 空特征向量 (默认)

属性：

IconFileTestCaseResult — 测试用例结果图标 空特征向量 (默认)

属性：

IconFileTestFileResult — 测试文件结果图标 空特征向量 (默认)

属性：

IconFileTestIterationResult — 迭代结果图标 空特征向量 (默认)

属性：

IconFileTestSuiteResult — 测试套件结果图标 空特征向量 (默认)

属性：

IconModelReference — 模型参考图标 空特征向量 (默认)

属性：

IconTopLevelModel — 顶层模型图标 空特征向量 (默认)

属性：

IncludeComparisonSignalPlots — 包括比较信号图 false (默认) | true

属性：

IncludeCoverageResult — 包括覆盖率结果 false (默认) | true

属性：

IncludeErrorMessages — 包含错误消息 true (默认) | false

属性：

IncludeMWVersion — 包含 MATLAB 版本 true (默认) | false

属性：

IncludeSimulationMetaData — 包括仿真元数据 false (默认) | true

属性：

IncludeSimulationSignalPlots — 包括仿真信号图 false (默认) | true

属性：

IncludeTestRequirement — 包括测试需求 true (默认) | false

属性：

IncludeTestResults — 包括全部或部分测试结果 2 (默认) | 0 | 1

属性：

LaunchReport — 完成后打开报告 true (默认) | false

属性：

ReportTitle — 报告标题 空特征向量 (默认)

属性：

SectionSpacing — 各部分之间的间距 '2mm' (默认) | 字符向量

属性：

SignalPlotHeight — 地模块高度 '600px' (默认) | 字符向量

属性：

SignalPlotWidth — 地模块宽度 '500px' (默认) | 字符向量

属性：

TableFontColor — 表格字体颜色 'Black' (默认) | 字符向量

属性：

`resultObjects` — 结果集对象
对象

`reportFilePath` — 生成报告的文件名和路径
字符向量

`AuthorName` — 作者姓名
空特征向量 (默认)

`BodyFontColor` — 正文段落字体颜色
`'Black'` (默认) | 字符向量

`BodyFontName` — 正文段落字体样式名称
`'Arial'` (默认) | 字符向量

`BodyFontSize` — 正文段落字体大小
`'12pt'` (默认) | 字符向量

`ChapterIndent` — 一级压痕宽度
`'3mm'` (默认) | 字符向量

`ChapterIndentL2` — 二级压痕宽度
`'6mm'` (默认) | 字符向量

`ChapterIndentL3` — 三级压痕宽度
`'8mm'` (默认) | 字符向量

`CustomTemplateFile` — 模板文件名和路径
空特征向量 (默认)

`HeadingFontColor` — 部分标题字体颜色
`'Black'` (默认) | 字符向量

`HeadingFontName` — 节标题字体样式名称
`'Arial'` (默认) | 字符向量

`HeadingFontSize` — 章节标题字体大小
`'14pt'` (默认) | 字符向量

`IconFileOutcomeDisabled` — 已禁用的测试结果图标
空特征向量 (默认)

`IconFileOutcomeFailed` — 失败的测试结果图标
空特征向量 (默认)

`IconFileOutcomeIncomplete` — 不完整的测试结果图标
空特征向量 (默认)

`IconFileOutcomeMisaligned` — 测试结果图标未对齐
空特征向量 (默认)

`IconFileOutcomePassed` — 通过的测试结果图标
空特征向量 (默认)

`IconFileTestCaseResult` — 测试用例结果图标
空特征向量 (默认)

`IconFileTestFileResult` — 测试文件结果图标
空特征向量 (默认)

`IconFileTestIterationResult` — 迭代结果图标
空特征向量 (默认)

`IconFileTestSuiteResult` — 测试套件结果图标
空特征向量 (默认)

`IconModelReference` — 模型参考图标
空特征向量 (默认)

`IconTopLevelModel` — 顶层模型图标
空特征向量 (默认)

`IncludeComparisonSignalPlots` — 包括比较信号图
`false` (默认) | `true`

`IncludeCoverageResult` — 包括覆盖率结果
`false` (默认) | `true`

`IncludeErrorMessages` — 包含错误消息
`true` (默认) | `false`

`IncludeMWVersion` — 包含 MATLAB 版本
`true` (默认) | `false`

`IncludeSimulationMetaData` — 包括仿真元数据
`false` (默认) | `true`

`IncludeSimulationSignalPlots` — 包括仿真信号图
`false` (默认) | `true`

`IncludeTestRequirement` — 包括测试需求
`true` (默认) | `false`

`IncludeTestResults` — 包括全部或部分测试结果
`2` (默认) | `0` | `1`

`LaunchReport` — 完成后打开报告
`true` (默认) | `false`

`ReportTitle` — 报告标题
空特征向量 (默认)

`SectionSpacing` — 各部分之间的间距
`'2mm'` (默认) | 字符向量

`SignalPlotHeight` — 地模块高度
`'600px'` (默认) | 字符向量

`SignalPlotWidth` — 地模块宽度
`'500px'` (默认) | 字符向量

`TableFontColor` — 表格字体颜色
`'Black'` (默认) | 字符向量

`TableFontName` — 表格字体样式名称
`'Arial'` (默认) | 字符向量

`TableFontSize` — 表格字体大小
`'7.5pt'` (默认) | 字符向量

`TitleFontColor` — 标题字体颜色
`'Black'` (默认) | 字符向量

`TitleFontName` — 标题字体样式名称
`'Arial'` (默认) | 字符向量

`TitleFontSize` — 标题字体大小
`'16pt'` (默认) | 字符向量