Show / Hide Table of Contents

    Class MetricCollector

    Responsible for collecting metrics for various things inside NBench

    Inheritance
    System.Object
    MetricCollector
    CounterMetricCollector
    GcCollectionsPerGenerationCollector
    GcTotalMemoryCollector
    TimingCollector
    Implements
    System.IDisposable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: NBench.Collection
    Assembly: NBench.dll
    Syntax
    public abstract class MetricCollector : IDisposable

    Constructors

    MetricCollector(MetricName, String)

    Declaration
    protected MetricCollector(MetricName name, string unitName)
    Parameters
    Type Name Description
    MetricName name
    System.String unitName

    Properties

    Name

    The name of this metric

    Declaration
    public MetricName Name { get; }
    Property Value
    Type Description
    MetricName

    UnitName

    The unit this metric is measured by

    Declaration
    public string UnitName { get; }
    Property Value
    Type Description
    System.String

    WasDisposed

    Declaration
    public bool WasDisposed { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Collect()

    Collects the value of this metric

    Declaration
    public abstract double Collect()
    Returns
    Type Description
    System.Double

    Dispose()

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Declaration
    protected void Dispose(bool dispose)
    Parameters
    Type Name Description
    System.Boolean dispose

    DisposeInternal()

    Internal method for disposing any resources used by a specific MetricCollector implementation.

    Declaration
    protected virtual void DisposeInternal()

    Implements

    System.IDisposable
    Back to top Copyright © 2015-2020 Petabridge™, LLC