Main Content

sldvreport

Generate Simulink Design Verifier report

Description

[status, reportFilePath] = sldvreport(sldvDataFile) generates a complete HTML report from the data in sldvDataFile. If sldvreport creates the report, status returns true. reportFilePath contains the actual name of the HTML report.

[status, reportFilePath] = sldvreport(sldvDataFile, {reportOption1, reportOption2, ...}) generates a complete HTML report from the data in sldvDataFile based on the specified options. options is a cell array.

[status, reportFilePath] = sldvreport(sldvDataFile, {reportOption1, reportOption2, ...}, reportFilePath) generates a complete HTML report from the data in sldvDataFile based on the specified options and saves it in the location reportFilePath.

[status, reportFilePath] = sldvreport(sldvDataFile, {reportOption1, reportOption2, ...}, reportFilePath, showUI) generates a complete HTML report from the data in sldvDataFile based on the specified options and saves it in the location reportFilePath. If showUI is true, the software displays the status of the report generation in the user interface.

example

[status, reportFilePath] = sldvreport(sldvDataFile, {reportOption1, reportOption2, ...}, reportFilePath, showUI, FORMAT) generates a complete report in the specified FORMAT from the data in sldvDataFile based on the specified options and saves it in the location reportFilePath. If showUI is true, the software displays the status of the report generation in UI.

[status, reportFilePath] = sldvreport(sldvDataFile, {reportOption1, reportOption2, ...}, reportFilePath, showUI, FORMAT, Filter) generates a complete report in the specified FORMAT by applying the justification rules specified in the analysis filter file Filter and the data in sldvDataFile.

Examples

collapse all

Analyze the model and create a PDF of the Simulink® Design Verifier™ analysis report by using sldvreport.

Open the sldvdemo_cruise_control example model.

open_system('sldvdemo_cruise_control');

Set the sldvoptions and create a PDF version of the analysis results.

opts = sldvoptions;                      
opts.Mode = 'TestGeneration';           
opts.SaveReport = 'off';                                        
[status, files ] = sldvrun('sldvdemo_cruise_control', opts); 
[status, reportFilePath] = sldvreport(files.DataFile, ...
 {'summary','objectives'}, 'C:\work\sldvdemo_cruise_control_report', false, 'PDF');

Input Arguments

collapse all

Name of the data file that contains the analysis results.

Cell array that specifies these options for the report.

'summary'

Include summary analysis data only (Default: false)

'objectives'

Include test objective data (Default: true)

'objects'

Include data about all model objects (Default: true)

'testcases'

Include data about all generated test cases (Default: true)

'properties'

Include data about all properties that are proven or are falsified (Default: true)

The path and the file name for the generated report.

Logical value indicating where to display messages during analysis.

true to display messages in the log window.
false (default) to display messages in the MATLAB® Command Window.

Entry indicating whether to generate the report in HTML, PDF, or both.

'HTML' (default) to generate an HTML format of the report.
'PDF' to generate a PDF version of the report.
{'HTML', 'PDF'} to generate HTML and PDF formats of the report.

This parameter is case sensitive. Use only capital letters for this parameter.

Name of the analysis filter file that contains the justification rules.

Example: 'sldvdemo_design_error_detection_sldv_filter.cvf'

Output Arguments

collapse all

If the operation creates the analysis report, sldvreport returns a status of true. Otherwise, it returns false.

The path and the file name for the generated HTML report.

Alternatives

Simulink Design Verifier software creates an HTML report after analyzing a model. In the Configuration Parameters dialog box, in the Design Verifier > Report pane, select Generate report of the results. If you want to save a PDF of the report, select Generate additional report in PDF format.

Introduced in R2009b