Main Content

matlab.perftest.TimeResult class

Package: matlab.perftest
Superclasses: matlab.unittest.measurement.MeasurementResult

Result from running time experiment

Description

Objects of the TimeResult class hold information describing the result from running a time experiment on a test suite using the matlab.perftest.TimeExperiment class. Objects contain information about the time measurements and the corresponding functional test results.

The test results are available as a table.

Creation

The MATLAB® testing framework creates an instance of the TimeResult class when you run a time experiment.

Properties

expand all

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

Example: 'MyTestSuite'

Attributes:

GetAccess
public
SetAccess
protected

Data Types: char

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).

Attributes:

GetAccess
public
SetAccess
private
Dependent
true
NonCopyable
true

Data Types: logical

Information about sample measurements, returned as a table with the following information.

Column NameDescription
NameName of the test suite element. If a measurement label is specified, Name is appended with the measurement label delimited by angle brackets.
MeasuredValueValue of the measurement. Experiments can give this column a more specific name, such as MeasuredTime.
TimestampTime when measurement is collected.
HostMachine name where measurement is collected.
PlatformPlatform architecture on which measurement is collected.
VersionMATLAB Version used in test.
RunIdentifierUnique identifier of measurement run.

Attributes:

GetAccess
public
SetAccess
private
Dependent
true
NonCopyable
true

Data Types: 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 NameDescription
PassedLogical value indicating if the test passed
FailedLogical value indicating if the test failed
IncompleteLogical value indicating if test run is incomplete
ObjectiveCategorical value indicating the type of measurement: sample or warmup
TestResultTestResult object from the functional test

Attributes:

GetAccess
public
SetAccess
private
Dependent
true
NonCopyable
true

Data Types: table

Methods

expand all

Introduced in R2019a