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

slreq.generateReport

生成需求报告器

全页折叠

语法

myReportPath = slreq.generateReport(myReqSets)
myReportPath = slreq.generateReport(myReqSets,myReportOpts)

说明

myReportPath = slreq.generateReport(myReqSets) 根据 myReqSets 指定的需求集，使用默认选项生成一份报告。

示例

myReportPath = slreq.generateReport(myReqSets,myReportOpts) 根据 myReportOpts 指定的选项生成需求报告。

示例

示例

全部折叠

打开实时脚本

打开 ShortestPath 工程。

proj = openProject("ShortestPath");

加载 shortest_path_func_reqs 需求集。

myReqSet = slreq.load("shortest_path_func_reqs");

生成需求报告。

myReportPath = slreq.generateReport(myReqSet);
Starting report generation...
0%****************************************************100%
Requirements Toolbox report generated: C:\Users\jdoe\MATLAB\Examples\GenerateRequirementsReportExample\ShortestPath\slreqrpt_20241008.docx
打开实时脚本

打开 ShortestPath 工程。

proj = openProject("ShortestPath");

获取默认报告生成选项。

myReportOpts = slreq.getReportOptions;

加载 shortest_path_func_reqs 需求集。

myReqSet = slreq.load("shortest_path_func_reqs");

执行需求集的测试。

status = runTests(myReqSet);

指定报告路径。从报告中排除目录。

myReportOpts.reportPath = fullfile(proj.RootFolder, ...
    "FunctionalRequirementsReport.html");
myReportOpts.includes.toc = false;

生成需求报告。

myReportPath = slreq.generateReport(myReqSet,myReportOpts);
Starting report generation...
0%****************************************************100%
Requirements Toolbox report generated: C:\Users\ahoward\OneDrive - MathWorks\Documents\MATLAB\ExampleManager\ahoward.examples\slrequirements-ex92550242\ShortestPath\FunctionalRequirementsReport.html

输入参数

全部折叠

报告中需包含的需求，以 slreq.ReqSet 数组或 "all" 格式指定，该数组包含报告中所有已加载的需求集。

报告生成选项，指定为包含以下字段的结构：

提示

使用 slreq.getReportOptions 函数创建此结构。要更改设置，请在将其用作输入参量之前修改结构.

报告文件名和路径，指定为字符向量。

是否自动打开报告的选项，通过逻辑值 1 (true)"）或 0 (false)"）指定。

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

报告作者，指定为字符向量。

报告中包含的内容，以具有以下字段的结构形式指定：

是否包含目录的选项，指定为逻辑值 1 (true)"）或 0 (false)"）。

是否包含报告生成日期，为选项，可选择以逻辑值 1 (true)"）或 0 (false)"）指定。

是否包含需求集修订号，以逻辑值 1 (true)"）或 0 (false)"）指定选项。

是否包含需求属性，选项为逻辑值 1 (true)"）或 0 (false)"）。

是否包含链接的选项，通过逻辑值 1 (true)"）或 0 (false)"）指定。

是否包含需求变更信息，作为逻辑值 1 (true)"）或 0 (false)"）的选项。

报告中使用的链接分组，指定为 'Artifact' 或 'LinkType'。

是否包含需求关键字的选项，以逻辑值 1 (true)"）或 0 (false)"）指定。

包含需求说明的选项，以逻辑值 1 (true)"）或 0 (false)"）指定。

实现状态的包含选项，指定为逻辑值 1 (true)"）或 0 (false)"）。

验证状态的包含选项，以逻辑值 1 (true)"）或 0 (false)"）指定。

是否包含空需求属性，通过逻辑值 0 (false)"）或 1 (true)"）作为选项指定。

是否包含理由的选项，以逻辑值 1 (true)"）或 0 (false)"）指定。

是否包含自定义属性，通过逻辑值 1 (true)"）或 0 (false)"）作为选项指定。

输出参量

全部折叠

报告文件路径，以字符向量形式返回。

提示

  • 要在需求报告中包含最新验证状态，请在生成报告前先运行需求集的测试。要程序化地运行测试，请使用 runTests 函数。有关如何交互式运行测试的更多信息，请参阅 审查需求验证状态。

版本历史记录

在 R2018a 中推出

另请参阅

函数

主题