Interface IProjectHistoricAnalysisResult
Represents an NDepend project's settings relative to historic analysis results storage.
public interface IProjectHistoricAnalysisResult- Extension Methods
Properties (5)
CustomHistoricAnalysisResultDirectory
Gets or sets the custom directory where historic analysis results are stored in a hierarchy of sub-directories.
IDirectoryPath CustomHistoricAnalysisResultDirectory { get; set; }Property Value
Remarks
This path is taken account only if UseCustomHistoricAnalysisResultDirectory is set to true.
Else the default path $(NdProjectOutputDir) is used to store History Analysis Results.
An empty value for this property is represented by a null reference..
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.HistoricAnalysisResult_CustomDirectoryPath activated.
HistoricAnalysisResultDirectory
Gets the absolute path to the directory where historic analysis results are stored in a hierarchy of sub-directories.
IAbsoluteDirectoryPath HistoricAnalysisResultDirectory { get; }Property Value
Remarks
The returned path takes account of the value of UseCustomHistoricAnalysisResultDirectory.
PersistRecurrence
Gets or sets the frequency of when historic analysis results are stored.
LogRecurrence PersistRecurrence { get; set; }Property Value
Remarks
When this property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.HistoricAnalysisResult_Settings activated.
RetentionNDays
Gets or sets the number of retention days. When a new analysis is run on this project, any historical analysis results older than this number of days are deleted.
uint RetentionNDays { get; set; }Property Value
Remarks
The value 0 means no deletion will occur. This is the default value.
UseCustomHistoricAnalysisResultDirectory
Gets or sets a boolean that indicates if the value of CustomHistoricAnalysisResultDirectory is used to define the directory that stores Trend Metrics Values, or if the default path $(NdProjectOutputDir) is used instead..
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.HistoricAnalysisResult_Settings activated.
bool UseCustomHistoricAnalysisResultDirectory { get; set; }Property Value
Method (1)
GetHistoricAnalysisResultSettingsDescription()
Returns a plain english description of the historic analysis results storage settings.
string GetHistoricAnalysisResultSettingsDescription()