RingBufferRead (FPScript)
Reads a section of a trace from a HistoryBase ring buffer.
Syntax
RingBufferRead(HistoryBaseFile, Machine, Group, TraceName, FromTime, ToTime)
The syntax of the RingBufferRead function consists of the following parts:
Part |
Description |
|---|---|
HistoryBaseFile |
Path to the HistoryBase ring buffer file to be read. Permitted data structures are scalar value. Supported data types are string (file name). |
Machine |
Name of the network computer on which the HistoryBase ring buffer server is running. This argument can also be an empty text. In this case, the HistoryBase instance of the ring buffer will be searched or, if necessary, instantiated on the executing machine. Permitted data structures are scalar value. Supported data types are string. |
Group |
Name of the trace group in the ring buffer containing the trace to be imported. Permitted data structures are scalar value. Supported data types are string. |
TraceName |
Name of the trace to be imported. Permitted data structures are scalar value. Supported data types are string. |
FromTime |
The date and time of the first (oldest) value to be read from the trace. Permitted data structures are scalar value. Supported data types are 32-bit integer, 64-bit floating point und calendar time. |
ToTime |
The date and time of the last (most recent) value to be read from the trace. This date and time value must be greater than the value specified in FromTime. Permitted data structures are scalar value. Supported data types are 32-bit integer, 64-bit floating point und calendar time. |
Remarks
The result always has the data structure data series.
The Weisang HistoryBase ring buffer version 2.4 or higher has to be installed on the executing system and, if applicable, on the system specified by Machine.
If an argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
RingBufferRead("C:\RingBuffer.rbf", "RemoteMachine", "SPS", "Signal", '2010/1/1 10:00', '2010/1/1 11:00') |