PINCompFilDat()
- Last UpdatedNov 21, 2022
- 2 minute read
- PI System
- PI DataLink 2023 SP1
- Visualization
Returns a specific number of filtered PI point values or filtered PI AF attribute values beginning at a certain time.
Syntax
PINCompFilDat(DataItem, STime, NumVals, FiltExp, FiltCode, OutCode, RootPath, Mode)
Arguments
|
Argument |
Type |
Description |
|---|---|---|
|
DataItem |
String |
The PI point name or PI AF attribute name for which the function returns a value. Specify a range of cells that contain PI point names or PI AF attribute names to return a value for each. |
|
STime |
String |
The start of the time period for which the function returns values. See Time inputs. |
|
NumVals |
Integer |
The number of values that the function returns, beginning at STime (specify a negative number to retrieve values backward in time). |
|
FiltExp |
String |
A Boolean performance equation that the function uses to filter values. When the expression evaluates to false, the function excludes corresponding values. See Filter expressions. |
|
FiltCode |
Integer |
A code that indicates whether to label filtered values:
|
|
OutCode |
Integer |
An output code that determines what appended data the function returns and how the function orients output. See Output codes for information on how to compute the code. This function supports bits 1, 2, 5, and 6. |
|
RootPath |
String |
The path to the data item. See Data items. |
|
Mode |
String |
The method that the function uses to determine which values to retrieve near the start time (boundary type):
|
Example
=PINCompFilDat("sinusoid","2:00:00",10,"'cdep158'>38",1,1,"","inside")
Returns ten values and the corresponding time stamps from the default Data Archive server for the PI point sinusoid starting from 2:00 a.m. this morning, when the point cdep158 is greater than 38, using boundary type inside.
The output contains the label Filtered between any values where the filter condition was false.