PIPointList.InterpolatedValues Method

public IEnumerable<AFValues> InterpolatedValues(
	AFTimeRange timeRange,
	AFTimeSpan interval,
	string filterExpression,
	bool includeFilteredValues,
	PIPagingConfiguration pagingConfig
)

Public Function InterpolatedValues ( 
	timeRange As AFTimeRange,
	interval As AFTimeSpan,
	filterExpression As String,
	includeFilteredValues As Boolean,
	pagingConfig As PIPagingConfiguration
) As IEnumerable(Of AFValues)

Dim instance As PIPointList
Dim timeRange As AFTimeRange
Dim interval As AFTimeSpan
Dim filterExpression As String
Dim includeFilteredValues As Boolean
Dim pagingConfig As PIPagingConfiguration
Dim returnValue As IEnumerable(Of AFValues)

returnValue = instance.InterpolatedValues(timeRange, 
	interval, filterExpression, includeFilteredValues, 
	pagingConfig)

public:
IEnumerable<AFValues^>^ InterpolatedValues(
	AFTimeRange timeRange, 
	AFTimeSpan interval, 
	String^ filterExpression, 
	bool includeFilteredValues, 
	PIPagingConfiguration^ pagingConfig
)

member InterpolatedValues : 
        timeRange : AFTimeRange * 
        interval : AFTimeSpan * 
        filterExpression : string * 
        includeFilteredValues : bool * 
        pagingConfig : PIPagingConfiguration -> IEnumerable<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.

filterExpression

Type: SystemString
A filter expression that follows the performance equation syntax.

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.

pagingConfig

Type: OSIsoft.AF.PIPIPagingConfiguration
Contains the paging configuration parameters for the request.

Return Value

An enumerable of AFValues for each PIPoint in the list. The results are not guaranteed to match the order of the PIPointList, and duplicate points in the list will not produce a duplicate result. The results can be mapped back to the corresponding PI Point using the PIPoint property on each result.

The order of the results are predictable; however, if you need the results in the same order as the attribute list, then consider using a dictionary keyed by PI Point to construct a list in the same order.

The points in the list are broken up by their corresponding PI Data Archive. A bulk call is made against each PI Data Archive in parallel. The results are made available as they are returned from the PI Data Archive in the order that the bulk calls were made.

The following example shows a list of points including duplicates from three different PI Data Archives:

This table shows the order that the results would be returned:

Since the first point is on the Contoso PI Data Archive, it is the first PI Data Archive to receive a bulk call; therefore, all Contoso point results will be returned first. Duplicate points do not produce a duplicate result, so the duplicate Contoso Lobby_Room_Temperature does not produce a second return value. After the Contoso results have been returned, the Northwind results are returned followed by the AdventureWorks results.

AFSDK

Reference