PICompFilDat()
- Last UpdatedNov 21, 2022
- 2 minute read
- PI System
- PI DataLink 2023 SP1
- Visualization
Returns filtered PI point values or filtered PI AF attribute values stored during a specified time period.
Syntax
PICompFilDat(DataItem, STime, ETime, 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 values. Specify a range of cells that contain PI point names or PI AF attribute names to return values for each. |
|
STime |
String |
The start of the time period for which the function returns values. See Time inputs. |
|
ETime |
String |
The end of the time period for which the function returns values. See Time inputs. |
|
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, 4, 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 STime or ETime (boundary type):
|
Example
=PICompFilDat("sinusoid","2:00:00","10:00:00","'cdep158'>38",1,1,"","inside")
Returns values and the corresponding time stamps for the PI point sinusoid from the default Data Archive server, starting at 2:00 a.m. and ending at 10:00a.m., when the PI 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.