CodeMetricFactory.cs :  » Development » devAdvantage » AnticipatingMinds » CodeInsight » C# / CSharp Open Source

using System;

namespace AnticipatingMinds.CodeInsight{
  /// <summary>
  /// Represents a code metric factory class.
  /// </summary>
  /// <remarks>
  /// Code Metrics are loaded dynamicly by CodeInsigh Platform. 
  /// To load code metrics, the assemblies are scanned for the presense of class inherited from 
  /// <see cref="CodeMetricsFactory"/> class. When such type is found it is instatiated and <see cref="GetMetrics"/> 
  /// method is called to retrive a set of metrics exported by assembly.
  /// </remarks>
  public abstract class CodeMetricsFactory
  {
    protected CodeMetricsFactory()
    {
    }

    /// <summary>
    /// Gets an array of metrics exported by assembly.
    /// </summary>
    /// <returns></returns>
    public abstract CodeMetric[] GetMetrics();
  }
}