matlab.unittest.measurement.MeasurementResult Class

Namespace: matlab.unittest.measurement

Base class for classes holding measurement results

Description

The MeasurementResult class is the base class for classes that hold the results from running a measurement experiment on test suites. These classes contains the measurement values, categories, and timestamps, and information about the functional test results.

When you run an experiment, the testing framework returns an object of a concrete class that is derived from the MeasurementResult class. One object for each Test object in the suite.

Properties

Name — Name of the test suite element

character vector

Name of the test suite element that corresponds to the measurement result, returned as a character vector.

Valid — Indicator if measurement is valid

logical 0 or 1

Indicator if the measurement is valid, returned as logical 0 or 1. A measurement is valid (logical 1) if it is collected from a passing test. Otherwise it is invalid (logical 0).

Samples — Information about sample measurements

table

Information about sample measurements, returned as a table containing these columns:

Column Name	Description
Name	Name of the test suite element.
MeasuredValue	Value of the measurement. Experiments can give this column a more specific name, such as MeasuredTime.
Timestamp	Time of measurement.
Host	Machine name.
Platform	Platform architecture.
Version	MATLAB Version.
RunIdentifier	Unique identifier of measurement run.

The Samples table does not include information from warm-up runs.

TestActivity — Information about all test activity

table

Information about all test activity, including the warm-up measurements, returned as a table. This table is useful when you want all the data, such as during debugging or when performing a more involved data analysis. The TestActivity table contains these columns in addition to the columns described for Samples:

Column Name	Description
Passed	Logical value indicating if the test passed
Failed	Logical value indicating if the test failed
Incomplete	Logical value indicating if test run is incomplete
Objective	Categorical value indicating the type of measurement: sample or warmup
TestResult	TestResult object from the functional test

Methods

sampleSummary	Create table of summary statistics from MeasurementResult array
samplefun	Apply function across samples of MeasurementResult array

Version History

Introduced in R2016a

R2019a: Changed to an abstract class

The matlab.unittest.measurement.MeasurementResult class has become an abstract class. MeasurementResult objects saved in previous releases are loaded as matlab.unittest.measurement.DefaultMeasurementResult objects.