SamplingModeType Parameter
Calculated.| Properties | Description | Value |
|---|---|---|
| Undefined | Sampling mode is not defined. | 0 |
| CurrentValue | Retrieves the current value. The time- interval criteria are ignored. | 1 |
| Interpolated | Retrieves evenly-spaced, interpolated values based on interval or NumberOfSamples and the time-frame criteria. | 2 |
| Trend | Returns the raw minimum and raw maximum value for each specified interval. Use the Trend sampling mode to maximize performance when retrieving data points for plotting. For the Trend sampling mode, if the sampling interval does not evenly divide by the interval length, Historian ignores any leftover values at the end, rather than putting them into a smaller interval. | 3 |
| RawByTime | Retrieves raw archive values based on time-frame criteria. | 4 |
| RawByNumber | Retrieves raw archive values based on the StartTime criteria, the NumberOfSamples, and Direction criteria. The EndTime criteria is ignored for this sampling mode. | 5 |
| Calculated | Retrieves evenly spaced calculated values based on NumberOfSamples, interval, the time frame criteria, and the CalculationMode criteria. | 6 |
| Lab | Returns actual collected values without interpolation. | 7 |
| InterpolatedtoRaw | Provides raw data in place of interpolated data when the number of samples are fewer than the available samples. | 8 |
| TrendtoRaw | The TrendtoRaw sampling mode almost always produces the same results as the Trend sampling mode. However, when more samples are requested than there are raw data points, the TrendtoRaw sampling mode returns all available raw data points with no further processing. Use TrendtoRaw in place of Trend when this condition exists. | 9 |
| LabtoRaw | Provides raw data for the selected calculated data, when NumberOfSamples is less than the available samples. | 10 |
| RawByFilterToggle | Returns filtered time ranges using the following values:
This sampling mode is used with the time range and filter tag conditions. The response string starts with a starting time stamp and ends with an ending timestamp. | 11 |