captureBaselineCriteria

Class: sltest.testmanager.TestCase
Namespace: sltest.testmanager

Capture baseline criteria and add to test case

Syntax

baseline = captureBaselineCriteria(tc,file,append) baseline = captureBaselineCriteria(tc,file,append,Name,Value)

Description

baseline = captureBaselineCriteria(tc,file,append) runs the system under test and captures a baseline criteria set as a MAT-file, Simulation Data Inspector (SDI) MLDATX file, or Microsoft^® Excel^® file. The function returns a baseline criteria object, sltest.testmanager.BaselineCriteria. Use this function only if the test type is a baseline test case.

Note

If your model has multiple variant subsystems, capture independent baselines for each variant subsystem, instead of reusing a baseline.

baseline = captureBaselineCriteria(tc,file,append,Name,Value) uses additional options specified by one or more Name,Value pair arguments.

Input Arguments

expand all

`tc` — Test case
`sltest.testmanager.TestCase` object

Test case to capture baseline criteria in, specified as an sltest.testmanager.TestCase object.

`file` — Excel, MAT, or SDI MLDATX filename and path
character vector

File and pathname of the baseline criteria file, specified as a character vector. You can specify a MAT-file, Simulation Data Inspector MLDATX file, or a Microsoft Excel file.

Example: 'C:\MATLAB\baseline_API.mat'

`append` — Append baseline criteria
`true` | `false`

Append baseline criteria if criteria already exists, specified as a Boolean. The Boolean true appends to existing criteria, and false replaces existing criteria.

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: 'Sheet','mysheet','Range','C1:F10'

Pairs for MAT-Files, Simulation Data Inspector (SDI) .mldatx file, and Microsoft Excel Files

expand all

`Release` — Simulink^® release to capture the baseline in
character vector | string array

Simulink release to capture the baseline data in, specified as a character vector or string array. Use a release specified in your preferences. For more information, see sltest.testmanager.getpref and sltest.testmanager.setpref.

Example: 'Release','R2017a'

`CaptureForIterations` — Capture baseline data for test case iterations
`false` (default) | `true`

Whether to capture baseline data for test case iterations, specified as a Boolean.

Example: 'CaptureForIterations',true

Pairs Only for Microsoft Excel Files

expand all

`Sheet` — Name of sheet to capture baseline criteria to
character vector | string array

Name to sheet to capture baseline criteria to, specified as a character vector or string array.

Example: 'Sheet','testinputs'

`Range` — Range of cells
character vector | string array

Ranges of cells to capture baseline criteria to, specified as a character vector or string array. You can specify 'Range' only if you also specify 'Sheet'.

Example: 'Range','B2:C30'

Output Arguments

expand all

`baseline` — Baseline criteria object
object

Baseline criteria added to the test case, returned as an sltest.testmanager.BaselineCriteria object.

Examples

expand all