assumeSignalsMatch

Class: sltest.TestCase
Namespace: sltest

Assume two data sets are equivalent

Since R2020b

Syntax

assumeSignalsMatch(testCase,actual,expected)

assumeSignalsMatch(___,diagnostic)

assumeSignalsMatch(___,Name,Value)

Description

assumeSignalsMatch(testCase,actual,expected) assumes that the actual and expected signal data values are equivalent. When an assumption fails, the test stops running at the test point or test file, and the test is marked as incomplete. For more information, see matlab.unittest.qualifications.Assumable.

assumeSignalsMatch(___,diagnostic) returns diagnostic information when the actual and expected data values are not equivalent.

assumeSignalsMatch(___,Name,Value) filters test content with additional options specified by one or more Name,Value pair arguments.

Input Arguments

testCase — Instance of test case

sltest.TestCase object

Instance of the test case, specified as an sltest.TestCase object.

actual — Actual values to compare to expected values

time series data | string | character array

Actual values to compare to expected values, specified as time series data, a string, or character array. The data for each actual value must pair data value with time value. The data must be in a format supported by the Simulation Data Inspector. The Simulation Data Inspector requires data in a format that associates sample values with time. Supported formats include timeseries, Structure with time, and Dataset.

Example: 'C:/matlab/data/actualData.mat'

expected — Expected values to use as the baseline for the comparison

time series data | string scalar | character array

Expected values to use as the baseline for the comparison. The data for each expected value must pair data value with time value. The data must be in a format supported by the Simulation Data Inspector. The Simulation Data Inspector requires data in a format that associates sample values with time. Supported formats include timeseries, Structure with time, and Dataset.

Example: 'C:/matlab/data/expectedData.mat'

diagnostic — Diagnostic information

string | character vector | function handle | matlab.automation.diagnostics.Diagnostic instance

Diagnostic information to display when the assumption that the actual and expected values are equivalent fails, specified as a string, character array, a function handle, or an instance of a matlab.automation.diagnostics.Diagnostic class.

Example: 'Simulation output does not match.'

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'AbsTol',.02

In addition to the listed Name-Value pairs, you can use the Simulink.sdi.constraints.MatchesSignal Name-Value pairs.

AbsTol — Absolute tolerance

0 (default) | scalar

Absolute tolerance, specified as the comma-separated pair consisting of 'AbsTol' and the scalar value of the tolerance. The tolerance specifies the magnitude of the difference between the actual and expected values.

Example: 'AbsTol',1e-9

RelTol — Relative tolerance

0 (default) | scalar

Relative tolerance, specified as the comma-separated pair consisting of 'RelTol' and the scalar value of the tolerance. The relative tolerance specifies the magnitude of the difference between the actual and expected values, relative to the expected value.

Example: 'RelTol',.002

TimeTol — Time tolerance

0 (default) | scalar

Time tolerance, specified as the comma-separated pair consisting of 'TimeTol' and the scalar value of the tolerance.

Example: 'TimeTol',.2

Attributes

Access	public
Sealed	true

To learn about attributes of methods, see Method Attributes.

Examples

Assume that Back-to-Back Simulations Match

Create a test case for interactive use. Then, simulate the model in normal mode to obtain the expected values, and simulate in rapid accelerator mode to obtain the actual values. Use assumeSignalsMatch to compare the values.

testCase =...
   sltest.TestCase.forInteractiveUse;
 
expected = testCase.simulate('myModel',...
   'SimulationMode','Normal');
actual = testCase.simulate('myModel',...
   'SimulationMode','Rapid-Accelerator');
 
testCase.assumeSignalsMatch(actual,expected)

Assume that Simulation Outputs Match Within a Specified Tolerance

Create a test case for interactive use. Simulate the model in rapid accelerator mode to obtain the actual values. Use assumeSignalsMatch to compare the actual values to the baseline values saved in a MAT-file. Set an absolute tolerance.

testCase =...
   sltest.TestCase.forInteractiveUse;
 
actual = testCase.simulate('myModel',...
   'SimulationMode','Rapid-Accelerator');

testCase.assumeSignalsMatch(actual,'baseline.mat',...
   'AbsTol',1e-12)
 

Assume that Simulations Match and Display Custom Diagnostic Message

Create a test case for interactive use. Then, simulate the model in rapid accelerator mode to obtain the actual values. Use assumeSignalsMatch to compare the actual values to the baseline values saved in a MAT-file. Specify the diagnostic message to display if the assumption fails.

testCase =...
   sltest.TestCase.forInteractiveUse;
 
actual = testCase.simulate('myModel',...
   'SimulationMode','Rapid-Accelerator');
 
testCase.assumeSignalsMatch(actual,'baseline.mat',...
   'Rapid-Accel output did not match.')
 

Version History

Introduced in R2020b