PIAdvCalcVal()
- Last UpdatedNov 21, 2022
- 2 minute read
- PI System
- PI DataLink 2023 SP1
- Visualization
Returns a value calculated from PI point or PI AF attribute values during a specified time period. This function supports bulk calls.
Syntax
PIAdvCalcVal(DataItem, STime, ETime, Mode, CalcBasis, MinPctGood, CFactor, OutCode, RootPath)
Arguments
|
Argument |
Type |
Description |
|---|---|---|
|
DataItem |
String |
The PI point name or PI AF attribute name for which the function calculates a value. Specify a range of cells that contain PI point names or PI AF attribute names to calculate a value for each. |
|
STime |
String |
The start of the time period for which the function calculates a value. See Time inputs. |
|
ETime |
String |
The end of the time period for which the function calculates a value. See Time inputs. |
|
Mode |
String |
The type of calculation that the function performs:
|
|
CalcBasis |
String |
The calculation method:
|
|
MinPctGood |
Number |
The minimum percentage of good data required during the time period to calculate and return a value. |
|
CFactor |
Number |
A factor that the function applies to the returned value. Enter 1 if a conversion factor is not needed. For time-weighted total calculations, specify a factor that converts recorded rate values to the server default time unit (units per day). |
|
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 2, 3, and 9 (if Mode is set to minimum, maximum, or range). |
|
RootPath |
String |
The path to the data item. See Data items. |
Example
=PIAdvCalcVal("sinusoid","y","t","total","time-weighted",50,1,4,"")
Returns a time-weighted total of the PI point sinusoid calculated from the values on the default Data Archive server from yesterday to today.
The function multiplies the result by 1, and only returns a result if at least 50 percent of the data is good. The function returns the percent good to the right of the calculated total.