AFDataReference.InterpolatedValueAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns a single AFValue whose value is
interpolated at the passed time.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public virtual Task<AFValue> InterpolatedValueAsync( AFTime time, AFAttributeList inputAttributes, AFValues inputValues, CancellationToken cancellationToken )
Public Overridable Function InterpolatedValueAsync ( time As AFTime, inputAttributes As AFAttributeList, inputValues As AFValues, cancellationToken As CancellationToken ) As Task(Of AFValue) Dim instance As AFDataReference Dim time As AFTime Dim inputAttributes As AFAttributeList Dim inputValues As AFValues Dim cancellationToken As CancellationToken Dim returnValue As Task(Of AFValue) returnValue = instance.InterpolatedValueAsync(time, inputAttributes, inputValues, cancellationToken)
public: virtual Task<AFValue^>^ InterpolatedValueAsync( AFTime time, AFAttributeList^ inputAttributes, AFValues^ inputValues, CancellationToken cancellationToken )
abstract InterpolatedValueAsync : time : AFTime * inputAttributes : AFAttributeList * inputValues : AFValues * cancellationToken : CancellationToken -> Task<AFValue> override InterpolatedValueAsync : time : AFTime * inputAttributes : AFAttributeList * inputValues : AFValues * cancellationToken : CancellationToken -> Task<AFValue>
Parameters
- time
- Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired. - inputAttributes
- Type: OSIsoft.AF.AssetAFAttributeList
The input attributes as previously specified by the data reference in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference. - inputValues
- Type: OSIsoft.AF.AssetAFValues
The input values are supplied to the data reference based on the attributes returned in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference. - cancellationToken
- 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: TaskAFValueReturns a task whose result is the AFValue for the attribute. The timestamp of the value will be at the requested time.
Exceptions
| Exception | Condition |
|---|---|
| AggregateException | Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure. |
Remarks
| 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. |