RingBufferReadTime (FPScript)
Reads a section of a time trace from a HistoryBase ring buffer.
Syntax
RingBufferReadTime(HistoryBaseFile, Machine, FromTime, ToTime, [ CalendarTime = TRUE ] [ , SubRate = 1 ])
The syntax of the RingBufferReadTime 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. |
FromTime |
The date and time of the first (oldest) time value to be read. 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) time value to be read. This date and time must be greater than the date and time specified in FromTime. Permitted data structures are scalar value. Supported data types are 32-bit integer, 64-bit floating point und calendar time. |
CalendarTime |
Boolean value specifying that the time data are to be read as calendar times. Otherwise, the time is provided in seconds where FromTime corresponds to zero. Permitted data structures are scalar value. Supported data types are Boolean value. If this argument is omitted, it will be set to the default value TRUE. |
SubRate |
Integer value which specifies the sub-rate. Time is reduced according to the given sub-rate to return the time values for a trace belonging to a group having a sub-rate. This parameter is evaluated only when working with HistoryBase 3 or higher. Permitted data structures are scalar value. All integral data types are permitted. The value must be greater or equal to 1. If this argument is omitted, it will be set to the default value 1. |
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. The result is provided in UTC time format.
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
RingBufferReadTime("C:\RingBuffer.rbf", "RemoteMachine", '2010/1/1 10:00', '2010/1/1 11:00') |