Click or drag to resize
OSIsoft, LLC

PIPointInterpolatedValuesAsync Method

Retrieves interpolated values over the specified time range at the specified sampling interval.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public Task<AFValues> InterpolatedValuesAsync(
	AFTimeRange timeRange,
	AFTimeSpan interval,
	string filterExpression,
	bool includeFilteredValues,
	CancellationToken cancellationToken = null


Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the interpolated values request. If the StartTime is earlier than the EndTime, the resulting values will be in time-ascending order, otherwise they will be in time-descending order.
Type: OSIsoft.AF.TimeAFTimeSpan

The Sample interval. If specified in hours, minutes, seconds, or milliseconds, the time intervals will be evenly spaced UTC time intervals. Longer interval types are interpreted using wall clock rules and are time zone dependent. For example, an interval created with the string "24h" means using an evenly spaced 24 UTC hour interval between each event. On the other hand, an interval created with the string "1d" would return an interval shorter or longer than 24 hours if the interval encompasses a Daylight Savings Time change.

When a positive interval is specified, the interval calculation begins at the earliest bounding time in the timeRange and applies the interval repeatedly in time ascending direction to generate the calculation intervals.

If a negative interval is specified, the interval calculation begins at the latest bounding time in the timeRange and applies the interval repeatedly in time descending direction to generate the calculation intervals. Note that the order of values returned will still be reflected by the timeRange, regardless of the interval sign.

Type: SystemString
A filter expression that follows the performance equation syntax.
Type: SystemBoolean
Specify to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a "Filtered" enumeration value with bad status. Repeated consecutive failures are omitted.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.

Return Value

Type: TaskAFValues
Returns a task whose result is an AFValues collection with the interpolated values.
AggregateException Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.

Important note Important
Impersonation of AF SDK asynchronous calls relies on the .NET framework's built-in support for flowing execution context across asynchronous points. When making these calls while impersonating, the thread or runtime must be configured to propagate the impersonation across these asynchronous points (see the SecurityContext documentation for details).

Note Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8
See Also
Enabling Operational Intelligence