matlab.unittest.plugins.diagnosticrecord.ExceptionDiagnosticRecord Class

Namespace: matlab.unittest.plugins.diagnosticrecord
Superclasses: matlab.unittest.plugins.diagnosticrecord.DiagnosticRecord

Diagnostic information about errors

Description

The ExceptionDiagnosticRecord class defines the diagnostic information about errors that the DiagnosticsRecordingPlugin includes on the TestResult. The DiagnosticsRecordingPlugin creates this class, so there is no need for test authors to construct the class directly.

Properties

Exception — Error information

MException object

Error information, returned as an MException object.

AdditionalDiagnosticResults — Results of additional diagnostics specified in the test content

array of DiagnosticResult instances

Results of additional diagnostics specified in the test content, represented as an array of DiagnosticResult instances. For example, AdditionalDiagnosticResults includes results from diagnostics added using the matlab.unittest.TestCase.onFailure method.

These properties are inherited from matlab.unittest.plugins.diagnosticrecord.DiagnosticRecord:

Event — Name of recorded event

character vector

Name of recorded event, returned as a character vector. This property corresponds to the event on the TestCase instance.

Example: 'VerificationPassed'

Example: 'ExceptionThrown'

Example: 'DiagnosticLogged'

Data Types: char

EventLocation — Location of event

character vector

Location of event, returned as a character vector. This property corresponds to the label of the test content.

Example: 'myTestClass'

Example: 'myTestClass/testMethod1'

Example: 'myTestClass[classSetupParam=value1]/testMethod1'

Example: 'mySharedTestFixture'

Data Types: char

EventScope — Scope where event originated

instance of matlab.unittest.Scope

Scope where event originated, returned as an instance of matlab.unittest.Scope. This property corresponds to the label of the test content.

Example: matlab.unittest.Scope.TestMethod

Example: matlab.unittest.Scope.TestClass

Example: matlab.unittest.Scope.SharedTestFixture

Stack — Stack trace to diagnostic

structure

Stack trace to the location of the diagnostic event, returned as a structure containing the fields file, name, and line.

Data Types: struct

Report — Diagnostic information

character vector

All diagnostic information, returned as a character vector. The report provides an overall summary of the event.

Data Types: char

Methods

Inherited Methods

selectFailed	Return diagnostic records for failed events
selectIncomplete	Return diagnostic records for incomplete events
selectLogged	Return diagnostic records for logged events
selectPassed	Return diagnostic records for passed events

Version History

Introduced in R2016a