Table of Contents

Interface IAnalysisResultRef

Namespace
NDepend.Analysis
Assembly
NDepend.API.dll

Represents a reference to a NDepend analysis result.

public interface IAnalysisResultRef
Extension Methods

Properties (6)

AnalysisResultFilePath

Gets the path to the analysis result data file.

IAbsoluteFilePath AnalysisResultFilePath { get; }

Property Value

IAbsoluteFilePath

Date

Gets the date when the analysis execution finished.

DateTime Date { get; }

Property Value

DateTime

Id

Gets the analysis result referenced Id if any, else returns the empty string.

string Id { get; }

Property Value

string

Remarks

You can assign the Id "v1.2.3" to an analysis result by adding the suffix "_Id_v1.2.3" to the analysis result .ndar file name like for example:
NDependAnalysisResult_YourProject_Date_Id_1.2.3.ndar
An Id is made of maximum 64 characters, excluding characters that cannot fit in a file name \ / : * ? " > < |.

IsHistoric

Returns true if the analysis data is stored in a historic directory. Returns false if the analysis data is stored in the project output directory.

bool IsHistoric { get; }

Property Value

bool

Remarks

A historic directory is a sub-directory of the project output directory.

Project

Gets the NDepend project from which the analysis has been done.

IProject Project { get; }

Property Value

IProject

ReportFilePath

Gets the path to the report file corresponding to the analysis result.

IAbsoluteFilePath ReportFilePath { get; }

Property Value

IAbsoluteFilePath

Methods (2)

Load()

Loads the analysis result corresponding to this analysis result reference.

IAnalysisResult Load()

Returns

IAnalysisResult

The analysis result loaded.

Exceptions

AnalysisException

If the analysis load fails, an AnalysisException with an informative message is thrown.

Load(Action<IProgressLog>)

Loads the analysis result corresponding to this analysis result reference.

IAnalysisResult Load(Action<IProgressLog> progressLogHandler)

Parameters

progressLogHandler Action<IProgressLog>

A procedure delegate object that is invoked each time the current analysis load emits a new IProgressLog object.

Returns

IAnalysisResult

The analysis result loaded.

Exceptions

AnalysisException

If the analysis load fails, an AnalysisException is thrown. This AnalysisException contains an inner exception with an informative message.