Main Content

slreq.generateReport

Generate report for requirement set

有限公司llapse all in page

Syntax

myReportPath = slreq.generateReport(reqSetList, reportOpts)

Description

myReportPath= slreq.generateReport(reqSetList,reportOpts)generates a report for the requirement sets specified byreqSetListusing the options specified byreportOptsand returns the pathmyReportPathto the report.

Examples

Generate Requirement Report

% Generate a requirement report in Microsoft(R) Word% format for all loaded requirement sets% Get default report generation options structuremyReportOpts = slreq.getReportOptions();% Specify the generated report path and file namemyReportOpts.reportPath ='L:\My_Project\Reqs_Report.docx';% Generate the report for all loaded requirement setsmyReport = slreq.generateReport('all', myReportOpts);

Note

To generate reports in PDF and HTML formats, specify a.pdfor a.htmlfile name as thereportPathvalue.

Input Arguments

有限公司llapse all

Requirement sets for report generation. You can specify a single requirement set or an array of requirement sets. To generate a report for all the loaded requirement sets, specify'all'as thereqSetListvalue. If you do not specify a value forreqSetList,'all'is used as default.

报告生成选项指定为一个MATLAB®structure. IfreportOptsis not specified, the report is generated using the default options specified inslreq.getReportOptions.

Options

Fields Data Type Description
reportPath character vector Generated report path.
titleText character vector Report title.
authors character vector Report authors.
includes.toc Boolean Option to include table of contents in your report.
includes.links Boolean Option to include requirements links in your report.
includes.rationale Boolean Option to include requirements rationale in your report.
includes.customAttributes Boolean Option to include requirement set custom attributes in your report
includes.comments Boolean Option to include requirement comments in your report.
includes.implementationStatus Boolean Option to include requirement implementation status data in your report.
includes.verificationStatus Boolean Option to include requirement verification status data in your report.
includes.keywords Boolean Option to include requirement implementation status data in your report.
includes.emptySections Boolean Option to include empty sections in your report.
includes.revision Boolean Option to include requirement revision information in your report.

Output Arguments

有限公司llapse all

The file path for the generated report, specified as a character vector.

Version History

Introduced in R2018a

See Also

Topics