Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / DataCriteria.SamplingModeType Enumeration


In This Topic
    DataCriteria.SamplingModeType Enumeration
    In This Topic
    Represents the supported data sampling modes.
    Syntax
    Public Enum DataCriteria.SamplingModeType 
       Inherits System.Enum
    public enum DataCriteria.SamplingModeType : System.Enum 
    public enum class DataCriteria.SamplingModeType : public System.Enum 
    Members
    MemberDescription
    Calculated Retrieves computed data samples based on supplied DataCriteria.CalculationModeType.
    CurrentValue Retrieves latest recorded data samples.
    Interpolated Retrieves regular, interpolated values for intervals in a time range.
    InterpolatedToRaw Hybrid interpolated sampling mode which reverts to raw sampling if the number of recorded data samples is fewer than requested.
    Lab Retrieves actual, recorded data samples repeated across intervals in a time range. Useful for creating a step chart rather than a continous graph.
    LabToRaw Hybrid lab sampling mode which reverts to raw sampling if the number of recorded data samples is fewer than requested.
    RawByFilterToggling Returns Data samples with 1 and 0 values when the filter condition becomes true and false in the interval mentioned . This sampling mode doesnt take TagName in to consideration . So irrespective what tagnames you mention in the query we will get results with the TagName "TimeRanges" in the output.
    RawByNumber Retrieves actual, recorded data samples based on start time, number and time order (forward or backward).
    RawByTime Retrieves actual, recorded data samples based on start and end time.
    Trend Retrieves maximum and minimum data values for intervals in a time range. Tailored for performance when plotting data.
    Trend2 Modified version of Trend sanpling. retrieves maximum and minimum data values for intervals in a time range and returns them with the timestamps of the raw values.
    TrendToRaw Hybrid trend sampling mode which reverts to raw sampling if the number of recorded data samples is fewer than requested.
    TrendToRaw2 Hybrid Trend2 sampling mode which reverts to raw sampling if the number of recorded data samples is fewer than requested.
    Undefined Undefined sampling mode.
    Inheritance Hierarchy

    System.Object
       System.ValueType
          System.Enum
             Proficy.Historian.ClientAccess.API.DataCriteria.SamplingModeType

    Requirements

    Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

    See Also