com.yoctopuce.YoctoAPI

Class YOldDataStream

java.lang.Object

com.yoctopuce.YoctoAPI.YDataStream

com.yoctopuce.YoctoAPI.YOldDataStream

public class YOldDataStream
extends YDataStream

YOldDataStream Class: Sequence of measured data, returned by the data logger A data stream is a small collection of consecutive measures for a set of sensors. A few properties are available directly from the object itself (they are preloaded at instantiation time), while most other properties and the actual data are loaded on demand when accessed for the first time. This is the old version of the YDataStream class, used for backward-compatibility with devices with firmware < 13000

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YDataStream

_avgVal, _calhdl, _calpar, _calraw, _calref, _caltyp, _columnNames, _decexp, _decimals, _duration, _functionId, _isAvg, _isClosed, _isScal, _isScal32, _maxVal, _minVal, _nCols, _nRows, _offset, _parent, _runNo, _samplesPerHour, _scale, _utcStamp, _values, DATA_INVALID

Constructor Summary

Constructors

Constructor and Description
YOldDataStream(YDataLogger parent, int run, int stamp, long utc, int itv)

Method Summary

Methods

Modifier and Type	Method and Description
double	get_dataSamplesInterval() Returns the number of seconds elapsed between two consecutive rows of this data stream.
int	get_startTime() Returns the relative start time of the data stream, measured in seconds.
double	getDataSamplesInterval() Returns the number of seconds elapsed between two consecutive rows of this data stream.
int	getStartTime() Returns the start time of the data stream, relative to the beginning of the run.
int	loadStream()

Methods inherited from class com.yoctopuce.YoctoAPI.YDataStream

_decodeAvg, _decodeVal, _get_url, _initFromDataSet, _parseStream, get_averageValue, get_columnCount, get_columnNames, get_data, get_dataRows, get_dataSamplesIntervalMs, get_duration, get_maxValue, get_minValue, get_rowCount, get_runIndex, get_startTimeUTC, isClosed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YOldDataStream

public YOldDataStream(YDataLogger parent,
              int run,
              int stamp,
              long utc,
              int itv)

Method Detail

loadStream

public int loadStream()
               throws YAPI_Exception

Overrides:

loadStream in class YDataStream

Throws:

YAPI_Exception

get_startTime

public int get_startTime()

Returns the relative start time of the data stream, measured in seconds. For recent firmwares, the value is relative to the present time, which means the value is always negative. If the device uses a firmware older than version 13000, value is relative to the start of the time the device was powered on, and is always positive. If you need an absolute UTC timestamp, use get_startTimeUTC().

Overrides:

get_startTime in class YDataStream

Returns:

an unsigned number corresponding to the number of seconds between the start of the run and the beginning of this data stream.

getStartTime

public int getStartTime()

Returns the start time of the data stream, relative to the beginning of the run. If you need an absolute time, use get_startTimeUTC(). This method does not cause any access to the device, as the value is preloaded in the object at instantiation time.

Returns:

an unsigned number corresponding to the number of seconds between the start of the run and the beginning of this data stream.

get_dataSamplesInterval

public double get_dataSamplesInterval()

Returns the number of seconds elapsed between two consecutive rows of this data stream. By default, the data logger records one row per second, but there might be alternative streams at lower resolution created by summarizing the original stream for archiving purposes. This method does not cause any access to the device, as the value is preloaded in the object at instantiation time.

Overrides:

get_dataSamplesInterval in class YDataStream

Returns:

an unsigned number corresponding to a number of seconds.

getDataSamplesInterval

public double getDataSamplesInterval()

Returns the number of seconds elapsed between two consecutive rows of this data stream. By default, the data logger records one row per second, but there might be alternative streams at lower resolution created by summarizing the original stream for archiving purposes. This method does not cause any access to the device, as the value is preloaded in the object at instantiation time.

Returns:

an unsigned number corresponding to a number of seconds.