matlab.unittest.diagnostics.ConstraintDiagnostic class
Package: matlab.unittest.diagnostics
Superclasses: matlab.automation.diagnostics.Diagnostic
Diagnostic with fields common to most constraints
Description
The ConstraintDiagnostic
class provides various textual fields that are
common to most constraints. These fields may be turned on or off depending on their
applicability.
The ConstraintDiagnostic
class is a helper class for displaying
diagnostics when using constraints. The ConstraintDiagnostic
class
provides custom constraint authors a way to add a common look and feel to diagnostics
produced by the getDiagnosticFor
method of constraints.
Constraint diagnostics are displayed in the following order: Description, Conditions, Actual Value, and Expected Value.
Properties
|
The actual value passed to the constraint for testing. |
|
Header information for the actual value property,
|
|
Formatted list of conditions, specified as a single character vector. Each
condition starts on a new line and begins with an arrow
( |
|
Number of conditions in the condition list. This is a read-only property
generated from the conditions list. The conditions list is defined in the
|
|
General diagnostic information, specified as a character vector. |
|
Indicator whether to display the actual value property,
|
|
Indicator of whether to display the |
|
Indicator of whether to display the |
|
Indicator whether to display the expected value property,
|
|
If applicable, the expected value. This property can be turned off if the associated constraint does not contain an expected value. |
|
Header information for the expected value property,
|
Inherited Properties
|
The artifacts produced during the last diagnostic evaluation, returned
as an array of |
|
The |
Methods
addCondition | Add condition to condition list |
addConditionsFrom | Add condition from another ConstraintDiagnostic to
condition list |
getDisplayableString | Convert object to string for display |
getPostActValString | Returns text to be displayed following actual value |
getPostConditionString | Returns text to be displayed following conditions list |
getPostDescriptionString | Returns text to be displayed following description |
getPostExpValString | Returns text to be displayed following expected value |
getPreDescriptionString | Returns text to be displayed prior to description |
Copy Semantics
Handle. To learn how handle classes affect copy operations, see Copying Objects.