slreq.generateReport
Generate report for requirement set
Description
generates a report for the requirement sets specified by
myReportPath
= slreq.generateReport(reqSetList
, reportOpts
)reqSetList
using the options specified by
reportOpts
and returns the path
myReportPath
to 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 structure myReportOpts = slreq.getReportOptions(); % Specify the generated report path and file name myReportOpts.reportPath = 'L:\My_Project\Reqs_Report.docx'; % Generate the report for all loaded requirement sets myReport = slreq.generateReport('all', myReportOpts);
Note
To generate reports in PDF and HTML formats, specify a
.pdf
or a .html
file name as
the reportPath
value.
Input Arguments
reqSetList
— Requirement set
character vector (default) | slreq.ReqSet
object | array
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 the
reqSetList
value. If you do not specify a value for
reqSetList
,
'all'
is used as
default.
reportOpts
— Report generation options
structure
Report generation options, specified as a MATLAB® structure. If reportOpts
is not
specified, the report is generated using the default options specified in
slreq.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. The report includes empty values for Requirement Type, Custom ID, Summary, and Description properties of your requirements regardless of this setting. |
includes.revision | Boolean | Option to include requirement revision information in your report. |
Output Arguments
myReportPath
— Generated report path
character vector
The file path for the generated report, specified as a character vector.
Version History
Introduced in R2018a
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)