AFDataReference.RecordedValuesAsync Method

public virtual Task<AFValues> RecordedValuesAsync(
	AFTimeRange timeRange,
	AFBoundaryType boundaryType,
	string filterExpression,
	bool includeFilteredValues,
	AFAttributeList inputAttributes,
	AFValues[] inputValues,
	List<AFTime> inputTimes,
	int maxCount,
	CancellationToken cancellationToken
)

Public Overridable Function RecordedValuesAsync ( 
	timeRange As AFTimeRange,
	boundaryType As AFBoundaryType,
	filterExpression As String,
	includeFilteredValues As Boolean,
	inputAttributes As AFAttributeList,
	inputValues As AFValues(),
	inputTimes As List(Of AFTime),
	maxCount As Integer,
	cancellationToken As CancellationToken
) As Task(Of AFValues)

Dim instance As AFDataReference
Dim timeRange As AFTimeRange
Dim boundaryType As AFBoundaryType
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim inputAttributes As AFAttributeList
Dim inputValues As AFValues()
Dim inputTimes As List(Of AFTime)
Dim maxCount As Integer
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.RecordedValuesAsync(timeRange, 
	boundaryType, filterExpression, 
	includeFilteredValues, inputAttributes, 
	inputValues, inputTimes, maxCount, 
	cancellationToken)

public:
virtual Task<AFValues^>^ RecordedValuesAsync(
	AFTimeRange timeRange, 
	AFBoundaryType boundaryType, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	AFAttributeList^ inputAttributes, 
	array<AFValues^>^ inputValues, 
	List<AFTime>^ inputTimes, 
	int maxCount, 
	CancellationToken cancellationToken
)

abstract RecordedValuesAsync : 
        timeRange : AFTimeRange * 
        boundaryType : AFBoundaryType * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        maxCount : int * 
        cancellationToken : CancellationToken -> Task<AFValues> 
override RecordedValuesAsync : 
        timeRange : AFTimeRange * 
        boundaryType : AFBoundaryType * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        maxCount : int * 
        cancellationToken : CancellationToken -> Task<AFValues> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the recorded 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.

boundaryType

Type: OSIsoft.AF.DataAFBoundaryType
A value from the AFBoundaryType enumeration that determines how the times and values of the returned end points are determined.

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.

inputTimes

Type: System.Collections.GenericListAFTime
The list of AFTime timestamps at which each input attribute was evaluated.

maxCount

Type: SystemInt32
The maximum number of values to be returned. If zero, then all of the events within the requested time range will be returned. When the maximum number of values is exceeded, if the timeRange provided has the start time before the end time, the earliest events are returned; if the start time is later than the end time, the latest events are returned

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

AFSDK

Reference