NDepend.API Documentation
CostToReachRating Method (IIssuesSet)
NDepend.Issue Namespace > IIssuesSet Interface : CostToReachRating Method
The code element on which we infer the cost to reach ratingToReach.
The rating to reach for codeElement
Returns the estimated effort to reach ratingToReach, based on the fact that codeElement has actually a total debt estimated to AllDebtIn(ICodeElement)(codeElement).
Syntax
Nullable<Debt> CostToReachRating( 
   ICodeElement codeElement,
   DebtRating ratingToReach
)

Parameters

codeElement
The code element on which we infer the cost to reach ratingToReach.
ratingToReach
The rating to reach for codeElement
Exceptions
ExceptionDescription
System.ArgumentExceptionThrown if the codeElement doesn't belong to CodeBase.
Remarks
If the actual rating of DebtRating(codeElement) is equals or better than ratingToReach, this method returns a zero duration NDepend.TechnicalDebt.Debt value.
This method implementation calls this.DebtFormatter.NDepend.TechnicalDebt.IDebtFormatter.CostToReachRating.
This method returns null if this.DebtFormatter.NDepend.TechnicalDebt.IDebtFormatter.ToDebtRatio(codeElement) returns null.
Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

See Also

Reference

IIssuesSet Interface
IIssuesSet Members

Send Feedback