run
Class: sltest.testmanager.TestFile
Namespace: sltest.testmanager
Run test cases in test file
Syntax
resultObj = run(tf)
resultObj = run(tf,Name,Value)
Description
runs the enabled test cases in the test file.resultObj
= run(tf
)
uses additional options specified by one or more name-value arguments.resultObj
= run(tf
,Name,Value
)
Input Arguments
tf
— Test file
sltest.testmanager.TestFile
object
Test file with the test cases you want to run, specified as
an sltest.testmanager.TestFile
object.
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.
Example: Parallel=true,SimulationMode="Accelerator"
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: "Parallel",true,"SimulationMode","Accelerator"
Parallel
— Whether to run with parallel computing
false
(default) | true
Whether to run tests with Parallel Computing Toolbox™ or MATLAB®
Parallel Server™, specified as either false
or
true
. Requires Parallel Computing Toolbox or MATLAB
Parallel Server license, respectively.
Example: run(tf,"Parallel",true)
Data Types: logical
SimulationMode
— Simulation mode for running tests
"Normal"
| "Accelerator"
| "Rapid Accelerator"
| "Software-in-the-Loop"
| "Processor-in-the-Loop"
Simulation mode to use for running a test file in the Test Manager,
specified as "Normal"
,
"Accelerator"
, "Rapid
Accelerator"
, "Software-in-the-Loop"
,
or "Processor-in-the-Loop"
. When you specify this
name-value argument, the setting overrides the simulation mode set in
the Test Manager. You do not need to update the test parameters or
settings when running the test file in the new mode.
The SimulationMode
value
Applies to both simulations in an equivalence test.
Applies to all iterations in a test case.
Applies to multirelease tests.
Does not apply to baseline captures.
Does not apply to real-time tests or MATLAB-based Simulink® tests.
If you set SimulationMode
to
"Software-in-the-Loop"
or
"Processor-in-the-Loop"
, and select
Override model blocks in SIL/PIL mode to normal
mode in the System Under Test
section of the Test Manager, the Test Manager uses the
SimulationMode
value to run the test.
Example: "SimulationMode","Accelerator"
Tags
— Run only tests with specified tags
string array | cell array of character vectors
Specifies test tags for execution. For more information, see Tags.
Example: run(tf,"Tags",["safety"])
Example: run(tf,"Tags",["safety","regression"])
Data Types: cell
| char
| string
Output Arguments
resultObj
— Results set object
sltest.testmanager.ResultSet
object
Test results, returned as a results set object, sltest.testmanager.ResultSet
.
Examples
Run a Test File
Open the model for this example.
openExample('sldemo_autotrans');
Create the test file, test suite, and test case structure.
tf = sltest.testmanager.TestFile("API Test File"); ts = createTestSuite(tf,"API Test Suite"); tc = createTestCase(ts,"simulation","Simulation Test Case");
Remove the default test suite.
tsDel = getTestSuiteByName(tf,"New Test Suite 1");
remove(tsDel);
Assign the system under test to the test case.
setProperty(tc,"Model","sldemo_autotrans");
Run the test file and return the results data.
ro = run(tf);
Run the Test File with Parallel Computing Toolbox
Open the model for this example.
openExample('sldemo_autotrans');
Create the test file, test suite, and test case structure.
tf = sltest.testmanager.TestFile("API Test File"); ts = createTestSuite(tf,"API Test Suite"); tc = createTestCase(ts,"simulation","Simulation Test Case");
Remove the default test suite.
tsDel = getTestSuiteByName(tf,"New Test Suite 1");
remove(tsDel);
Assign the system under test to the test case.
setProperty(tc,"Model","sldemo_autotrans");
Run the test file with Parallel Computing Toolbox and return the results data.
ro = run(tf,"Parallel",true);
Version History
Introduced in R2015bR2023a: Specify simulation mode
The SimulationMode
property overrides the simulation mode set
in the Test Manager. Use this property to run a test using a different mode without
having to change any test parameters or
settings.
See Also
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)