Main Content

matlab.unittest.plugins.plugindata.TestSuiteRunPluginData Class

Namespace: matlab.unittest.plugins.plugindata
Superclasses: matlab.unittest.plugins.plugindata.PluginData, matlab.unittest.plugins.plugindata.RunPluginData

Plugin data describing TestSuite portion being run

expand all in page

Description

The matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class defines the data passed by the test runner to plugin methods that extend the running of TestSuite portions.

The testing framework instantiates this class. You cannot create an object of the matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class directly.

The matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class is a handle class.

Properties

expand all

Name of the TestSuite portion being run by the test runner, returned as a character vector. You can use the Name property for informational, labeling, and display purposes. You cannot inspect the test content using this property.

Attributes:

GetAccess
public
SetAccess
immutable

Elements in the TestSuite portion being run, returned as a matlab.unittest.TestSuite array.

Attributes:

GetAccess
public
SetAccess
immutable

Results from the TestSuite portion being run, returned as a matlab.unittest.TestResult array.

Attributes:

GetAccess
public
SetAccess
Restricts access

Number of groups into which the entire TestSuite is divided, returned as a positive integer scalar. NumGroups is equal to 1 when tests run in serial mode and can be greater than 1 when tests run in parallel.

Attributes:

GetAccess
public
SetAccess
immutable

Identifier of the TestSuite portion being run, returned as a positive integer scalar from 1 to NumGroups.

Attributes:

GetAccess
public
SetAccess
immutable

Data buffer for storing and retrieving data related to the TestSuite portion being run, returned as a matlab.unittest.plugins.plugindata.CommunicationBuffer object. Use CommunicationBuffer with the storeIn and retrieveFrom methods of the matlab.unittest.plugins.Parallelizable interface.

The CommunicationBuffer property is useful when running tests in parallel with custom plugins (requires Parallel Computing Toolbox™).

Attributes:

GetAccess
public
SetAccess
private

Test result details modifier, returned as a matlab.unittest.plugins.plugindata.ResultDetails object. Use ResultDetails when you need to modify the Details property of TestResult objects.

Attributes:

GetAccess
public
SetAccess
private

Version History

Introduced in R2014a

expand all

See Also

| | | | |