EventFrame
- Last UpdatedJan 11, 2023
- 1 minute read
- PI System
- PI Server 2018
- PI Server
Return the value of event frame properties.
Syntax
EventFrame(parameter)
Arguments
-
parameter
parameter string StartTime, EndTime or Duration enclosed in double quotes; not case-sensitive
Returns
The value of the parameter
Exceptions
If the event frame is not active or still open, returns
Notes
-
This function is only to be used when configuring output expressions in an event frame generation analysis
-
The output can be mapped to an attribute with value type DateTime for StartTime and EndTime. For Duration, select double (time returned in seconds)
-
You can preview results by right-clicking the analysis
Example
-
EventFrame("Duration")
[Return the duration of an event frame. Time is returned in seconds]
-
TagAvg('att1', EventFrame("StartTime"), EventFrame("EndTime"))
[Find the time-weighted average of the values of 'att1' during an event frame]