slreq.getReportOptions

Get default requirements report generation options

collapse all in page

Syntax

myReportOpts = slreq.getReportOptions

Description

myReportOpts = slreq.getReportOptions returns the default options for requirements reports.

example

Examples

collapse all

Open Live Script

Open the ShortestPath project.

proj = openProject("ShortestPath");

Get the default report generation options.

myReportOpts = slreq.getReportOptions;

Load the shortest_path_func_reqs requirement set.

myReqSet = slreq.load("shortest_path_func_reqs");

Run the tests for the requirement set.

status = runTests(myReqSet);

Specify the report path. Exclude the table of contents from the report.

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

Generate the requirements report.

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

Output Arguments

collapse all

Report generation options, returned as a structure that has these fields:

Report file name and path, returned as a character vector.

Option to automatically open the report, returned as a logical 1 (true) or 0 (false).

Report title, returned as a character vector.

Report authors, returned as a character vector.

Content included in the report, returned as a structure that has these fields:

Whether report includes the table of contents, returned as a logical 1 (true) or 0 (false).

Whether report includes the report generation date, returned as a logical 1 (true) or 0 (false).

Whether report includes the requirement set revision number, returned as a logical 1 (true) or 0 (false).

Whether report includes requirement properties, returned as a logical 1 (true) or 0 (false).

Whether report includes links, returned as a logical 1 (true) or 0 (false).

Whether report includes the requirement change information, returned as a logical 1 (true) or 0 (false).

Link grouping used by report, returned as 'Artifact' or 'LinkType'.

Whether report includes requirement keywords, returned as a logical 1 (true) or 0 (false).

Whether report includes requirement comments, returned as a logical 1 (true) or 0 (false).

Whether report includes the implementation status, returned as a logical 1 (true) or 0 (false).

Whether report includes the verification status, returned as a logical 1 (true) or 0 (false).

Whether report includes empty requirement properties, returned as a logical 0 (false) or 1 (true).

Whether report includes the rationale, returned as a logical 1 (true) or 0 (false).

Whether report includes custom attributes, returned as a logical 1 (true) or 0 (false).

Version History

Introduced in R2018a

See Also

Functions

Topics