matlab.unittest.qualifications.QualificationEventData Class

Namespace: matlab.unittest.qualifications
Superclasses: event.EventData

Event data for qualification event listeners

Description

The matlab.unittest.qualifications.QualificationEventData class holds event data for qualification event listeners. Qualification event listeners are callback functions that you register with the testing framework to listen for passing qualifications, failing qualifications, or both. Qualifications can be assertions, fatal assertions, assumptions, or verifications performed on test content. The corresponding qualification classes define these events.

The testing framework instantiates this class. You cannot create an object of the matlab.unittest.qualifications.QualificationEventData class directly.

The matlab.unittest.qualifications.QualificationEventData class is a handle class.

Properties

ActualValue — Value passed to constraint for qualification

any value

Value passed to the constraint for qualification, returned as a value of any data type.

Attributes:

GetAccess	public
SetAccess	immutable

Constraint — Constraint used for qualification

matlab.unittest.constraints.Constraint object

Constraint used for qualification, returned as a matlab.unittest.constraints.Constraint object.

When you use a qualification method on a matlab.unittest.TestCase or matlab.unittest.fixtures.Fixture object, the Constraint property contains the underlying constraint used for the qualification. For example, if you use the verifyEqual method, the underlying constraint is the IsEqualTo constraint. Therefore, if you invoke the getDiagnosticFor method of the constraint, the diagnostic result can appear different from what the testing framework displays.

Attributes:

GetAccess	public
SetAccess	immutable

TestDiagnostic — Diagnostic action to be performed

character vector | string scalar | function handle | matlab.automation.diagnostics.Diagnostic object

Diagnostic action to be performed in the qualification, returned as a character vector, string scalar, function handle, or matlab.automation.diagnostics.Diagnostic object.

Attributes:

GetAccess	public
SetAccess	immutable

TestDiagnosticResults — Results of diagnostic action

array of matlab.automation.diagnostics.DiagnosticResult objects

Results of the diagnostic action performed in the qualification, returned as an array of matlab.automation.diagnostics.DiagnosticResult objects.

Attributes:

GetAccess	public
SetAccess	immutable

FrameworkDiagnosticResults — Results of diagnostic action from constraint

array of matlab.automation.diagnostics.DiagnosticResult objects

Results of the diagnostic action from the constraint used for the qualification, returned as an array of matlab.automation.diagnostics.DiagnosticResult objects.

Attributes:

GetAccess	public
SetAccess	immutable

Stack — Function call stack

structure array

Function call stack containing the list of function calls that led to the qualification event, returned as a structure array.

Attributes:

GetAccess	public
SetAccess	immutable

Version History

Introduced in R2014a