sltest.testmanager.TestIterationResult class

Package: sltest.testmanager

Access test iteration result data

Description

Instances of sltest.testmanager.TestIterationResult enable you to access the results from test execution performed by the Test Manager at a test-iteration level. The hierarchy of test results is Result Set > Test File Result > Test Suite Result > Test Case Result > Test Iteration Result.

The sltest.testmanager.TestIterationResult class is a handle class.

Class Attributes

HandleCompatible true

For information on class attributes, see Class Attributes.

Creation

Description

The function sltest.testmanager.run creates a sltest.testmanager.ResultSet object, which contains the test case result object. For an example, see Get Test Iteration Results

Properties

expand all

`Outcome` — Outcome of test iteration result
0 | 1 | 2 | 3

The outcome of an individual test iteration result. The integer 0 means the test iteration was disabled, 1 means the test iteration execution was incomplete, 2 means the test iteration passed, and 3 means the test iteration failed.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: integer

`Name` — Test iteration name
string

Test iteration name, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TestDataPath` — Input data file path
string

Path of the input data file, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TestFilePath` — Test file path
character vector

The path of the test file used to create the test iteration result, returned as a character vector.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: char

`TestCasePath` — Result hierarchy path
character vector

The hierarchy path in the parent result set.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: char

`TestCaseType` — Type of test case
`'Simulation'` | `'Baseline'` | `'Equivalence'`

The type of test case from the three available test cases in the Test Manager: simulation, baseline, and equivalence.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: char

`RunOnTarget` — Target indicator
cell array

Indicates if the simulation ran on the target or not, returned as an array of Booleans.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: logical

`StartTime` — Time the test iteration began to run
datetime

Time the test iteration began to run, returned as a datetime.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: datetime

`StopTime` — Time the test iteration completed
datetime

Time the test completed, returned as a datetime.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: datetime

`Duration` — Length of time the test iteration ran, in seconds
duration

Length of time the test iteration ran, in seconds, returned as a duration.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: duration

`Requirements` — Test iteration requirements
array of strings

Requirements associated with the test iteration, returned as an array of strings.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ErrorMessages` — Error messages
array of strings

Error messages produced by the iteration, returned as a array of strings.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: string

`LogMessages` — Log messages
array of strings

Log messages produced by the iteration, returned as a array of strings.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: string

`CauseOfFailure` — Cause of test iteration failure
array of strings

Cause of the test iteration failure, returned as an array of strings.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`DisablingReason` — Disabled description
string

Description text for why the test iteration was disabled, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`Baseline` — Name of baseline file
string

Name of the baseline file used in the test iteration, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ExternalInput` — Name of external input file
string

Name of external input file, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`ParameterSet` — Test iteration parameters
`ParameterSet` object

Test iteration parameters that can override model parameters, returned as a struct containing the name of the sltest.testmanager.ParameterSet object, path to the object, and a structure that lists the parameter overrides.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`SignalEditorScenario` — Name of Signal Editor scenario
string

Name of Signal Editor scenario used in the test iteration, returned as a string.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`TestSequenceScenario` — Test sequence scenario
struct

Test sequence scenario used in the test iteration, returned as a struct. The struct contains two fields, TestSequenceBlock and TestSequenceScenario. The TestSequenceBlock field is the path of the Test Sequence block containing the scenario that ran for this iteration. The TestSequenceScenario is the name of that scenario. The test sequence information is returned in a TestIterationResult object only if the test case included iterations. If iterations were not included, the TestSequenceScenario is returned in a TestCaseResults object.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: struct

`SimulationMetaData` — Metadata of the simulation
`SimulationMetadata` object

Metadata of the simulation, returned as a Simulink.SimulationMetadata object.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`Release` — Release in which the test was run
character vector

Release in which the test was run, returned as a character vector.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`Description` — Description of the test iteration
character vector

Description of the test iteration, returned as a character vector.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`CoverageResults` — Test coverage results
character array

Test coverage results, returned as a character array.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`Tags` — Tags to filter test file results
string array

Tags to filter the test file results. Use tags to view a subset of the test results. See Tags for more information.

Attributes:

`SetAccess`	`private`
`GetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

`Parent` — Parent of the result object
`sltest.testmanager.TestCaseResult` object

Parent of the test iteration result, returned as a TestCaseResult object.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`Dependent`	`true`
`NonCopyable`	`true`

Data Types: sltest.testmanager.TestCaseResult

`UserData` — Custom data stored with test iteration results
any data type

Custom data stored with the test iteration results, specified as any type of data. Use this field to add custom information, such as the settings used to obtain the results.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`Dependent`	`true`
`NonCopyable`	`true`

Methods

expand all

Public Methods

For getInputRuns, see the sltest.testmanager.testcaseresult getInputRunsmethod.

`getBaselineRun`	Get test iteration baseline dataset
`getComparisonResult`	Get test data comparison result
`getComparisonRun`	Get test iteration signal comparison results
`getCoverageResults`	Get coverage results
`getCustomCriteriaPlots`	Get plots from custom criteria
`getCustomCriteriaResult`	Get custom criteria results from test iteration
`getOutputRuns`	Get test iteration simulation output results
`getOutputTriggerResults`	Create output trigger results object for test iteration
`getSimulationPlots`	Get plots from callbacks
`getTestIteration`	Get test iteration that produced result
`getVerifyRuns`	Get test iteration verify statement

Examples

collapse all

Get Test Iteration Results

Open Live Script

Open the model for this example.

sldemo_absbrake

Create the test file, remove the default test suite, and add a new test suite and test case.

tf = sltest.testmanager.TestFile('Get Test Iteration Results File');
tsDel = tf.getTestSuites;
remove(tsDel);
ts = createTestSuite(tf,'Test Suite');
tc = createTestCase(ts,'baseline','Test Case');

Assign the system under test to the test case.

setProperty(tc,'Model','sldemo_absbrake');

Specify the parameter values for each iteration. Then run a for loop that creates a test iteration object for each iteration, sets the parameter value, and adds the iteration object to the test case structure.

vars = 32:0.5:34;

for k = 1:length(vars)

    % Create test iteration object
    testItr = sltest.testmanager.TestIteration;

    % Set the parameter value for this iteration
    setVariable(testItr,'Name','g','Source',...
       'base workspace','Value',vars(k));

    str = sprintf('Iteration %d',k);

    % Add the iteration object to the test case
    addIteration(tc,testItr,str);
end

Run the test and capture the results.

resultset = run(tf);
tfr = getTestFileResults(resultset);
tsr = getTestSuiteResults(tfr);
tcr = getTestCaseResults(tsr);
tir = getIterationResults(tcr);

Get the test case type from first iteration.

testType = tir(1).TestCaseType;

Clean up Test Manager.

sltest.testmanager.clear
sltest.testmanager.clearResults
sltest.testmanager.close

Version History

Introduced in R2016a

expand all

R2023a: New method to obtain triggered results

Use the new getOutputTriggerResults method to obtain the results of a test that uses triggers to control when signals are logged.

sltest.testmanager.TestIterationResult class

Description

Class Attributes

Creation

Description

Properties

Outcome — Outcome of test iteration result 0 | 1 | 2 | 3

Attributes:

Name — Test iteration name string

Attributes:

TestDataPath — Input data file path string

Attributes:

TestFilePath — Test file path character vector

Attributes:

TestCasePath — Result hierarchy path character vector

Attributes:

TestCaseType — Type of test case 'Simulation' | 'Baseline' | 'Equivalence'

Attributes:

RunOnTarget — Target indicator cell array

Attributes:

StartTime — Time the test iteration began to run datetime

Attributes:

StopTime — Time the test iteration completed datetime

Attributes:

Duration — Length of time the test iteration ran, in seconds duration

Attributes:

Requirements — Test iteration requirements array of strings

Attributes:

ErrorMessages — Error messages array of strings

Attributes:

LogMessages — Log messages array of strings

Attributes:

CauseOfFailure — Cause of test iteration failure array of strings

Attributes:

DisablingReason — Disabled description string

Attributes:

Baseline — Name of baseline file string

Attributes:

ExternalInput — Name of external input file string

Attributes:

ParameterSet — Test iteration parameters ParameterSet object

Attributes:

SignalEditorScenario — Name of Signal Editor scenario string

Attributes:

TestSequenceScenario — Test sequence scenario struct

Attributes:

SimulationMetaData — Metadata of the simulation SimulationMetadata object

Attributes:

Release — Release in which the test was run character vector

Attributes:

Description — Description of the test iteration character vector

Attributes:

CoverageResults — Test coverage results character array

Attributes:

Tags — Tags to filter test file results string array

Attributes:

Parent — Parent of the result object sltest.testmanager.TestCaseResult object

Attributes:

UserData — Custom data stored with test iteration results any data type

Attributes:

Methods

Public Methods

Examples

Get Test Iteration Results

Version History

R2023a: New method to obtain triggered results

See Also

Topics

WeChat

`Outcome` — Outcome of test iteration result
0 | 1 | 2 | 3

`Name` — Test iteration name
string

`TestDataPath` — Input data file path
string

`TestFilePath` — Test file path
character vector

`TestCasePath` — Result hierarchy path
character vector

`TestCaseType` — Type of test case
`'Simulation'` | `'Baseline'` | `'Equivalence'`

`RunOnTarget` — Target indicator
cell array

`StartTime` — Time the test iteration began to run
datetime

`StopTime` — Time the test iteration completed
datetime

`Duration` — Length of time the test iteration ran, in seconds
duration

`Requirements` — Test iteration requirements
array of strings

`ErrorMessages` — Error messages
array of strings

`LogMessages` — Log messages
array of strings

`CauseOfFailure` — Cause of test iteration failure
array of strings

`DisablingReason` — Disabled description
string

`Baseline` — Name of baseline file
string

`ExternalInput` — Name of external input file
string

`ParameterSet` — Test iteration parameters
`ParameterSet` object

`SignalEditorScenario` — Name of Signal Editor scenario
string

`TestSequenceScenario` — Test sequence scenario
struct

`SimulationMetaData` — Metadata of the simulation
`SimulationMetadata` object

`Release` — Release in which the test was run
character vector

`Description` — Description of the test iteration
character vector

`CoverageResults` — Test coverage results
character array

`Tags` — Tags to filter test file results
string array

`Parent` — Parent of the result object
`sltest.testmanager.TestCaseResult` object

`UserData` — Custom data stored with test iteration results
any data type