Table of Contents

Interface IProjectBaseline

Namespace
NDepend.Project
Assembly
NDepend.API.dll

Represents baseline settings of an NDepend project. It can be the settings for BaselineInUI or BaselineDuringAnalysis.

public interface IProjectBaseline
Extension Methods

Properties (5)

AnalysisResultCreatedNDaysAgo

Gets or sets the number of days ago, used when this baseline's AnalysisResultMode is set to BaselineAnalysisResultMode.NDaysAgoAnalysisResult.

uint AnalysisResultCreatedNDaysAgo { get; set; }

Property Value

uint

AnalysisResultMode

Gets or sets a value that determines with which analysis result the comparison occurs.

BaselineAnalysisResultMode AnalysisResultMode { get; set; }

Property Value

BaselineAnalysisResultMode

Remarks

The AnalysisResultMode value is only used when ProjectMode is different than DontCompare.
Specified values can be:
BaselineAnalysisResultMode.MostRecentAnalysisResultAvailable : compare with the most recent analysis result available.
BaselineAnalysisResultMode.NDaysAgoAnalysisResult : compare with an analysis result made N days ago. If no analysis result found, then try to find the closest analysis result.
BaselineAnalysisResultMode.ParticularAnalysisResult : compare with a particular analysis result.

OtherProjectFilePath

Gets or sets the other NDepend project file path, used when this baseline's ProjectMode is set to BaselineProjectMode.AnotherProject.

IFilePath OtherProjectFilePath { get; set; }

Property Value

IFilePath

Remarks

If the returned path is a relative path (IFilePath.IsRelativePath), the path is relative to the current NDepend project file path (IProjectProperties.FilePath.ParentDirectoryPath).
An empty value for this property is represented by a null reference.

ParticularAnalysisResultFilePath

Gets or sets the IAnalysisResultRef.AnalysisResultFilePath used when this baseline's AnalysisResultMode is set to BaselineAnalysisResultMode.ParticularAnalysisResult.

IFilePath ParticularAnalysisResultFilePath { get; set; }

Property Value

IFilePath

Remarks

If the returned path is a relative path (IFilePath.IsRelativePath), the path is relative to the current NDepend project file path (IProjectProperties.FilePath.ParentDirectoryPath).
An empty value for this property is represented by a null reference.

ProjectMode

Gets or sets a value that determines if the comparison doesn't occur, occurs with a previous analyis result of this NDepend project or occurs with a previous analyis result of another NDepend project.

BaselineProjectMode ProjectMode { get; set; }

Property Value

BaselineProjectMode

Remarks

Specified values can be:
ProjectMode.DontCompare : don't do comparison when doing a new analysis.
ProjectMode.CurrentProject : do a comparison with a previous analysis result of the current project.
ProjectMode.AnotherProject : do a comparison with a previous analysis result of another project.

Methods (2)

GetBaselineSettingsDescription()

Returns this baseline settings plain english description.

string GetBaselineSettingsDescription()

Returns

string

GetBaselineSettingsDescription(out DateTime?)

Returns this baseline settings plain english description.

string GetBaselineSettingsDescription(out DateTime? baselineDate)

Parameters

baselineDate DateTime?

Eventually returns the baseline date if available

Returns

string