Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFDataReference.InterpolatedValuesByCountAsync Method

AFDataReference.InterpolatedValuesByCountAsync Method

  • Last UpdatedNov 18, 2025
  • 4 minute read
AFDataReference.InterpolatedValuesByCountAsync Method
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.

Namespace:  OSIsoft.AF.Asset
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public virtual Task<AFValues> InterpolatedValuesByCountAsync(
	AFTimeRange timeRange,
	int numberOfValues,
	string filterExpression,
	bool includeFilteredValues,
	AFAttributeList inputAttributes,
	AFValues[] inputValues,
	CancellationToken cancellationToken
)
Public Overridable Function InterpolatedValuesByCountAsync ( 
	timeRange As AFTimeRange,
	numberOfValues As Integer,
	filterExpression As String,
	includeFilteredValues As Boolean,
	inputAttributes As AFAttributeList,
	inputValues As AFValues(),
	cancellationToken As CancellationToken
) As Task(Of AFValues)

Dim instance As AFDataReference
Dim timeRange As AFTimeRange
Dim numberOfValues As Integer
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim inputAttributes As AFAttributeList
Dim inputValues As AFValues()
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.InterpolatedValuesByCountAsync(timeRange, 
	numberOfValues, filterExpression, 
	includeFilteredValues, inputAttributes, 
	inputValues, cancellationToken)
public:
virtual Task<AFValues^>^ InterpolatedValuesByCountAsync(
	AFTimeRange timeRange, 
	int numberOfValues, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	AFAttributeList^ inputAttributes, 
	array<AFValues^>^ inputValues, 
	CancellationToken cancellationToken
)
abstract InterpolatedValuesByCountAsync : 
        timeRange : AFTimeRange * 
        numberOfValues : int * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        cancellationToken : CancellationToken -> Task<AFValues> 
override InterpolatedValuesByCountAsync : 
        timeRange : AFTimeRange * 
        numberOfValues : int * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        cancellationToken : CancellationToken -> Task<AFValues> 

Parameters

timeRange
Type: OSIsoft.AF.TimeAFTimeRange
The start and end time covered by the request.
numberOfValues
Type: SystemInt32
The number of interpolated values to return even spaced throughout the timeRange.
filterExpression
Type: SystemString
A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. A or empty string indicates no filtering. If the attribute does not support the Filters option, the filter will be ignored.
includeFilteredValues
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.
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: TaskAFValues
Returns a task whose result is an AFValues collection with the interpolated values.

Exceptions

ExceptionCondition
AggregateException Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.

Remarks

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

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in