Main Content

matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class

Package: matlab.unittest.plugins.plugindata

Plugin data describing TestSuite portion being run

Description

The TestSuiteRunPluginData class defines the data passed by the TestRunner to plugin methods that extend the running of test suite portions. The TestRunner instantiates this class, so you are not required to create an object of the class directly.

Properties

Name

Name of the test suite portion being run by the TestRunner, specified as a character vector. Use the Name property for informational, labeling, and display purposes. You cannot use this property to inspect the test content.

TestSuite

Specification of the elements in the test suite portion being run, specified as a matlab.unittest.TestSuite array.

TestResult

Results from the test suite portion being run, specified as a matlab.unittest.TestResult array.

NumGroups

Number of groups into which the entire test suite is divided, specified as a positive integer scalar. NumGroups is equal to 1 when tests run in serial mode.

Group

Identifier of the test suite portion being run, specified as a positive integer scalar between 1 and NumGroups.

CommunicationBuffer

Buffer for storing and retrieving data related to the test suite portion being run, specified as an instance of the matlab.unittest.plugins.plugindata.CommunicationBuffer class. Use CommunicationBuffer with the storeIn and retrieveFrom methods of the matlab.unittest.plugins.Parallelizable interface.

ResultDetails

Modifier of the test result details, specified as an instance of the matlab.unittest.plugins.plugindata.ResultDetails class. Use ResultDetails when you need to modify the Details property of TestResult objects.

Introduced in R2014a