linux-packaging-mono/mcs/class/System/Documentation/en/System.Diagnostics/CounterSampleCalculator.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="CounterSampleCalculator" FullName="System.Diagnostics.CounterSampleCalculator">
  <TypeSignature Language="C#" Maintainer="auto" Value="public static class CounterSampleCalculator" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit CounterSampleCalculator extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
    <AssemblyVersion>1.0.3300.0</AssemblyVersion>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>To be added</remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides a set of utility functions for interpreting performance counter data.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="ComputeCounterValue">
      <MemberSignature Language="C#" Value="public static float ComputeCounterValue (System.Diagnostics.CounterSample newSample);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig float32 ComputeCounterValue(valuetype System.Diagnostics.CounterSample newSample) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="newSample" Type="System.Diagnostics.CounterSample" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Diagnostics.CounterSampleCalculator.ComputeCounterValue(System.Diagnostics.CounterSample)" /> method overload returns meaningful results only for performance counters of the following <see cref="T:System.Diagnostics.PerformanceCounterType" />:</para>
          <list type="bullet">
            <item>
              <para>
                <see cref="F:System.Diagnostics.PerformanceCounterType.RawFraction" /> </para>
            </item>
            <item>
              <para>
                <see cref="F:System.Diagnostics.PerformanceCounterType.NumberOfItems32" />
              </para>
            </item>
            <item>
              <para>
                <see cref="F:System.Diagnostics.PerformanceCounterType.NumberOfItemsHEX32" />
              </para>
            </item>
            <item>
              <para>
                <see cref="F:System.Diagnostics.PerformanceCounterType.NumberOfItems64" />
              </para>
            </item>
            <item>
              <para>
                <see cref="F:System.Diagnostics.PerformanceCounterType.NumberOfItemsHEX64" />
              </para>
            </item>
          </list>
          <para>For other counter types, this overload always returns a value of 0 (zero).</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Computes the calculated value of a single raw counter sample.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A floating-point representation of the performance counter's calculated value.</para>
        </returns>
        <param name="newSample">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Diagnostics.CounterSample" /> that indicates the most recent sample the system has taken. </param>
      </Docs>
    </Member>
    <Member MemberName="ComputeCounterValue">
      <MemberSignature Language="C#" Value="public static float ComputeCounterValue (System.Diagnostics.CounterSample oldSample, System.Diagnostics.CounterSample newSample);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig float32 ComputeCounterValue(valuetype System.Diagnostics.CounterSample oldSample, valuetype System.Diagnostics.CounterSample newSample) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.MonoTODO("What's the algorithm?")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="oldSample" Type="System.Diagnostics.CounterSample" />
        <Parameter Name="newSample" Type="System.Diagnostics.CounterSample" />
      </Parameters>
      <Docs>
        <remarks>To be added</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Computes the calculated value of two raw counter samples.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A floating-point representation of the performance counter's calculated value.</para>
        </returns>
        <param name="oldSample">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Diagnostics.CounterSample" /> that indicates a previous sample the system has taken. </param>
        <param name="newSample">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Diagnostics.CounterSample" /> that indicates the most recent sample the system has taken. </param>
      </Docs>
    </Member>
  </Members>
</Type>