Table of Contents

Interface IQualityGate

Namespace
NDepend.Issue
Assembly
NDepend.API.dll

Represents a quality gate.

public interface IQualityGate
Extension Methods

Properties (13)

Fail

Returns true if the quality gate is satisfying its fail conditions.

bool Fail { get; }

Property Value

bool

FailThreshold

Gets the quality gate fail threshold.

double FailThreshold { get; }

Property Value

double

FailThresholdString

Return the quality gate fail threshold string formatted (without unit).

string FailThresholdString { get; }

Property Value

string

MoreIsBad

Returns true if when the value of the quality gate is increasing, th quality is considered worst.

bool MoreIsBad { get; }

Property Value

bool

Remarks

MoreIsBad is inferred from the fail if condition comparison operator.
If the comparison operator is higher or equals the threshold, then MoreIsBad is considered true.
If the comparison operator is lower the threshold, then MoreIsBad is considered false.

Name

The quality gate name.

string Name { get; }

Property Value

string

Pass

Returns true if the quality gate is not satisfying its warn nor fail conditions.

bool Pass { get; }

Property Value

bool

QueryString

The quality gate code query string.

string QueryString { get; }

Property Value

string

Status

The quality gate status Pass, Warn or Fail.

QualityGateStatus Status { get; }

Property Value

QualityGateStatus

Unit

The quality gate unit string.

string Unit { get; }

Property Value

string

Value

Return the quality gate value.

double? Value { get; }

Property Value

double?

Remarks

A quality gate with a null value always pass.

ValueString

Return the quality gate value string formatted with unit.

string ValueString { get; }

Property Value

string

Warn

Returns true if the quality gate is satisfying its warn conditions.

bool Warn { get; }

Property Value

bool

WarnThreshold

Gets the quality gate warn threshold or null if the warn threshold is not defined.

double? WarnThreshold { get; }

Property Value

double?