AFData.InterpolatedValuesAsync Method

public Task<AFValues> InterpolatedValuesAsync(
	AFTimeRange timeRange,
	AFTimeSpan interval,
	UOM desiredUOM,
	string filterExpression,
	bool includeFilteredValues,
	CancellationToken cancellationToken = default
)

Public Function InterpolatedValuesAsync ( 
	timeRange As AFTimeRange,
	interval As AFTimeSpan,
	desiredUOM As UOM,
	filterExpression As String,
	includeFilteredValues As Boolean,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFValues)

Dim instance As AFData
Dim timeRange As AFTimeRange
Dim interval As AFTimeSpan
Dim desiredUOM As UOM
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.InterpolatedValuesAsync(timeRange, 
	interval, desiredUOM, filterExpression, 
	includeFilteredValues, cancellationToken)

public:
Task<AFValues^>^ InterpolatedValuesAsync(
	AFTimeRange timeRange, 
	AFTimeSpan interval, 
	UOM^ desiredUOM, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	CancellationToken cancellationToken = CancellationToken()
)

member InterpolatedValuesAsync : 
        timeRange : AFTimeRange * 
        interval : AFTimeSpan * 
        desiredUOM : UOM * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<AFValues> 

Parameters

timeRange

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.

interval

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.

desiredUOM

Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned values. If , then the values are returned in the unit of measure specified by the associated attribute's DefaultUOM property.

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.

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

AFSDK

Reference