Main Content

matlab.unittest.diagnostics.ConstraintDiagnostic 类

包: matlab.unittest.diagnostics
超类: matlab.unittest.diagnostics.Diagnostic

此诊断的字段对大多数约束都通用

说明

ConstraintDiagnostic 类提供了大部分约束通用的各种文本字段。这些字段可能已开启,可能已关闭,具体取决于其适用性。

当使用约束时,ConstraintDiagnostic 类是用于显示诊断的辅助类。ConstraintDiagnostic 类为自定义约束的作者提供了一种方法,可以为约束的 getDiagnosticFor 方法所生成的诊断添加通用外观。

约束诊断按以下顺序显示:描述,条件,实际值和预期值。

属性

ActVal

传递到约束以用于测试的实际值。

ActValHeader

实际值属性 ActVal 的标题信息,指定为字符向量。默认标题为 'Actual Value:'

Conditions

格式化的条件列表,指定为单个字符向量。每个条件另起一行,以箭头 (-->) 分隔符开头。条件使用 addConditionaddConditionsFrom 方法添加到列表中。

ConditionsCount

条件列表中的条件数。这是从条件列表生成的只读属性。条件列表在 Conditions 属性中定义。

Description

常规诊断信息,指定为字符向量。

DisplayActVal

指示器,指出是否显示实际值属性 ActVal,指定为布尔值。默认情况下不显示实际值,此属性的值为 false

DisplayConditions

指示器,指出是否显示 Conditions 属性,指定为布尔值。默认情况下不显示条件,此属性的值为 false。即使 DisplayConditions 已设置为 true,如果条件列表中没有条件,也不会显示条件标题和条件列表。

DisplayDescription

指示器,指出是否显示 Description 属性,指定为布尔值。默认情况下不显示描述,此属性的值为 false

DisplayExpVal

指示器,指出是否显示预期值属性 ExpVal,指定为布尔值。默认情况下不显示预期值,此属性的值为 false

ExpVal

如果适用,是指预期值。如果相关联的约束不包含预期值,此属性可以关闭。

ExpValHeader

预期值属性 ExpVal 的标题信息,指定为字符向量。默认标题为 'Expected Value:'

继承的属性

Artifacts

上一次诊断评估期间生成的项目,以 FileArtifact 实例组成的数组形式返回。

DiagnosticText

DiagnosticText 属性为诊断的使用方(例如测试框架)提供了一种传达实际诊断消息的方法。该属性是一个字符向量,在计算 diagnose 方法期间定义。

方法

addCondition向条件列表中添加条件
addConditionsFrom将来自另一个 ConstraintDiagnostic 的条件添加到条件列表中
getDisplayableString将对象转换为字符串以用于显示
getPostActValString返回在实际值之后要显示的文本
getPostConditionString返回在条件列表之后要显示的文本
getPostDescriptionString返回在说明之后要显示的文本
getPostExpValString返回在预期值之后要显示的文本
getPreDescriptionString返回在描述之前要显示的文本

继承的方法

diagnose执行诊断操作
join将多个诊断联接为一个数组

复制语义

句柄。要了解句柄类如何影响复制操作,请参阅复制对象