Simulink.sdi.report - Generate report from Simulation Data Inspector tool

Syntax

Simulink.sdi.report() Simulink.sdi.report(Name,Value)

Description

Simulink.sdi.report() creates a report of the current view and data in the Inspect Signals tab in the Simulation Data Inspector.

Simulink.sdi.report(Name,Value) creates a report using the parameter Name, Value pairs, which specifies the information to include in the report.

Input Arguments

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments, where Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'ReportToCreate'

Specify which Simulation Data Inspector tab view to include in the report

Value Description

'Inspect Signals' (default) Information in the Inspect Signals tab view

'Compare Signals' Information in the Compare Signals tab view

'Compare Runs' Information in the Compare Runs tab view

Default: 'Inspect Signals'

'ReportOutputFolder'

MATLAB string specifying the location of the generated report.

Default: <current working folder>/slprj/sdi

'ReportOutputFile'

MATLAB string specifying the report file name.

Default: 'SDI_report.html'

'PreventOverwritingFile'

Boolean value. If the report file exists and the value is true, then the report generator increments the file name. If false, the report generator overwrites the report file, if it exists.

Default: true

'ColumnsToReport'

Matrix specifying values from the enumeration class, Simulink.sdi.SignalMetaData, which lists all signal metadata available in the Simulation Data Inspector. For example, to include the Run and Synchronization Method columns in the Compare Signals report, create a variable signal_metadata:

signal_metadata = [Simulink.sdi.SignalMetaData.Run, Simulink.sdi.SignalMetaData.SyncMethod];

Table Columns available for Inspect Signals and Compare Signals tabs:

Enumeration Element	Table Column Description
`BlockPath` (default)	Block path
`SignalName` (default)	Signal Name
`Line` (default)	Line style
`AbsTol` (default)	Positive number (user-specified)
`RelTol` (default)	Positive number (user-specified)
`SyncMethod`	Method to align time vector: union, intersection, uniform (user-specified)
`DataSource`	String signifying the source of data (`logsout.Stick.Data`)
`TimeSeriesRoot`	String signifying the name of the Simulink.Timeseries object (`logsout.Stick.Time`)
`TimeSource`	String signifying the array containing the time data (`logsout.Stick.Time`)
`InterpMethod`	Method to align data: zoh, linear (user-specified)
`Port`	Index of the output port that emits the signal logged
`Dimensions`	Number of dimensions of the signal
`Channel`	Channel of matrix data
`Run`	Name of a simulation run
`Model`	Model name for the signal data
`SID`	Simulink Identifier Run 1: SID Run 2: SID

Table columns available for the Compare Run tab:

Value	Description
`Result` (default)	Result of the comparison for the signal across the specified runs
`AbsTol1` (default)	Absolute tolerance
`RelTol1` (default)	Relative tolerance
`AlignedBy` (default)	Metadata used to align signal data between simulation runs
`LinkToPlot` (default)	Link to a plot of each comparison result
`BlockPath1`	Block path for signal from first run
`BlockPath2`	Block path for signal from second run
`SignalName1`	Signal name from first run
`SignalName2`	Signal name from second run
`DataSource1`	Name for the data from first run
`DataSource2`	Name for the data from second run
`SID1`	Simulink Identifier for the data from first run
`SID2`	Simulink Identifier for the data from second run
`SyncMethod1`	Synchronization method specified for the first run
`InterpMethod1`	Interpolation method specified for the first run
`Channel1`	Channel specified for the first run

'ShortenBlockPath'

Boolean value. If the value is true and the block path name is too long, the Simulation Data Inspector shortens the name in the report. If the value is false, the entire block path name is displayed in the report.

Default: true

'LaunchReport'

Boolean value. If the value is true after creation, the generated report opens.

Default: true

'SignalsToReport'

For the 'Compare Runs' view only.

Value Description

'ReportOnlyMismatchedSignals' Includes only the mismatched signals from comparing two runs

'ReportAllSignals' Includes all signals in the two compared runs

Default: 'ReportOnlyMismatchedSignals'

Examples

Create a report from the Inspect Signals view

% Configure model "sldemo_f14" for logging and simulate
simOut = sim('sldemo_f14', 'SaveOutput','on', ...
             'SaveFormat', 'StructureWithTime', ...
             'ReturnWorkspaceOutputs', 'on');
  
% Create a Data Inspector run
[~, ~, signalIDs] = Simulink.sdi.createRun('My Run', 'base', {'simOut'});
  
% Select signals for plotting
for i = 1:length( signalIDs )
   signal = Simulink.sdi.getSignal(signalIDs(i));
   signal.checked = true;
end
  
% Create default report, which is the Inspect Signals view
Simulink.sdi.report();

Create a report from the Compare Signals view

% Configure model "sldemo_f14" for logging and simulate
simOut = sim('sldemo_f14', 'SaveOutput','on', ...
             'SaveFormat', 'StructureWithTime', ...
             'ReturnWorkspaceOutputs', 'on');
  
% Create a Data Inspector run
[~, ~, signalIDs] = Simulink.sdi.createRun('My Run', 'base', {'simOut'});
  
% Compare two signals
Simulink.sdi.compareSignals( signalIDs(1), signalIDs(2) );
 
% Report on the signal comparison
Simulink.sdi.report('ReportToCreate', 'Compare Signals', ...
                    'ReportOutputFolder', tempdir, 'ReportOutputFile', 'myReport.html');

Create a report from the Compare Runs view

% Configure model "sldemo_f14" for logging and simulate
set_param('sldemo_f14/Pilot','WaveForm','square');
simOut = sim('sldemo_f14', 'SaveOutput','on', ...
                  'SaveFormat', 'StructureWithTime', ...
                  'ReturnWorkspaceOutputs', 'on');

% Create a Simulation Data Inspector run, Simulink.sdi.Run, from simOut in the base workspace
runID1 = Simulink.sdi.createRun('First Run','namevalue',{'simOut'},{simOut});

% Simulate again
set_param('sldemo_f14/Pilot','WaveForm','sawtooth');
simOut = sim('sldemo_f14', 'SaveOutput','on', ...
             'SaveFormat', 'StructureWithTime', ...
             'ReturnWorkspaceOutputs', 'on');
      
% Create another Simulation Data Inspector run
runID2 = Simulink.sdi.createRun('Second Run','namevalue',{'simOut'},{simOut});

% Compare two runs
difference = Simulink.sdi.compareRuns(runID1, runID2);

% Specify columns to include in the report
metaDataOfInterest = [Simulink.sdi.SignalMetaData.Result, ...
                    Simulink.sdi.SignalMetaData.BlockPath1, ...
                    Simulink.sdi.SignalMetaData.RelTol1];
% Report on the run comparison
Simulink.sdi.report('ReportToCreate', 'Compare Runs', ...
                    'ColumnsToReport', metaDataOfInterest, ...
                    'SignalsToReport', 'ReportAllSignals' );