AFDataReference.RecordedValuesByCountAsync Method

public virtual Task<AFValues> RecordedValuesByCountAsync(
	AFTime startTime,
	int count,
	bool forward,
	AFBoundaryType boundaryType,
	string filterExpression,
	bool includeFilteredValues,
	AFAttributeList inputAttributes,
	AFValues[] inputValues,
	List<AFTime> inputTimes,
	CancellationToken cancellationToken
)

Public Overridable Function RecordedValuesByCountAsync ( 
	startTime As AFTime,
	count As Integer,
	forward As Boolean,
	boundaryType As AFBoundaryType,
	filterExpression As String,
	includeFilteredValues As Boolean,
	inputAttributes As AFAttributeList,
	inputValues As AFValues(),
	inputTimes As List(Of AFTime),
	cancellationToken As CancellationToken
) As Task(Of AFValues)

Dim instance As AFDataReference
Dim startTime As AFTime
Dim count As Integer
Dim forward As Boolean
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 cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.RecordedValuesByCountAsync(startTime, 
	count, forward, boundaryType, filterExpression, 
	includeFilteredValues, inputAttributes, 
	inputValues, inputTimes, cancellationToken)

public:
virtual Task<AFValues^>^ RecordedValuesByCountAsync(
	AFTime startTime, 
	int count, 
	bool forward, 
	AFBoundaryType boundaryType, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	AFAttributeList^ inputAttributes, 
	array<AFValues^>^ inputValues, 
	List<AFTime>^ inputTimes, 
	CancellationToken cancellationToken
)

abstract RecordedValuesByCountAsync : 
        startTime : AFTime * 
        count : int * 
        forward : bool * 
        boundaryType : AFBoundaryType * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        cancellationToken : CancellationToken -> Task<AFValues> 
override RecordedValuesByCountAsync : 
        startTime : AFTime * 
        count : int * 
        forward : bool * 
        boundaryType : AFBoundaryType * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        cancellationToken : CancellationToken -> Task<AFValues> 

Parameters

startTime

Type: OSIsoft.AF.TimeAFTime
The start time of the request.

count

Type: SystemInt32
The number of compressed values to return. This number must be greater than zero.

forward

Type: SystemBoolean
A value of indicates to begin at the start time and move forward in time. A value of indicates to move backward in time. When moving backward, values will be returned in time descending order.

boundaryType

Type: OSIsoft.AF.DataAFBoundaryType
A value from the AFBoundaryType enumeration that determines how the time and value at the start time is 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.

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