YDataStream (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YDataStream

```
public class YDataStream
extends Object
```
YDataStream Class: Unformatted data sequence DataStream objects represent bare recorded measure sequences, exactly as found within the data logger present on Yoctopuce sensors. In most cases, it is not necessary to use DataStream objects directly, as the DataSet objects (returned by the get_recordedData() method from sensors and the get_dataSets() method from the data logger) provide a more convenient interface.

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`_avgVal`
`protected YAPI.CalibrationHandlerCallback`	`_calhdl`
`protected ArrayList<String>`	`_columnNames`
`protected double`	`_dataSamplesInterval`
`protected double`	`_duration`
`protected double`	`_firstMeasureDuration`
`protected String`	`_functionId`
`protected boolean`	`_isAvg`
`protected boolean`	`_isClosed`
`protected boolean`	`_isLoaded`
`protected double`	`_maxVal`
`protected double`	`_minVal`
`protected int`	`_nCols`
`protected int`	`_nRows`
`protected YFunction`	`_parent`
`protected int`	`_runNo`
`protected double`	`_startTime`
`protected long`	`_utcStamp`
`protected ArrayList<ArrayList<Double>>`	`_values`
`static double`	`DATA_INVALID`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`_decodeAvg(int dw, int count)`
`double`	`_decodeVal(int w)`
`String`	`_get_baseurl()`
`String`	`_get_url()`
`String`	`_get_urlsuffix()`
`int`	`_initFromDataSet(YDataSet dataset, ArrayList<Integer> encoded)`
`int`	`_parseCalibArr(ArrayList<Integer> iCalib)`
`int`	`_parseStream(byte[] sdata)`
`boolean`	`_wasLoaded()`
`double`	`get_averageValue()` Returns the average of all measures observed within this stream.
`int`	`get_columnCount()` Returns the number of data columns present in this stream.
`ArrayList<String>`	`get_columnNames()` Returns the title (or meaning) of each data column present in this stream.
`double`	`get_data(int row, int col)` Returns a single measure from the data stream, specified by its row and column index.
`ArrayList<ArrayList<Double>>`	`get_dataRows()` Returns the whole data set contained in the stream, as a bidimensional table of numbers.
`double`	`get_dataSamplesInterval()`
`int`	`get_dataSamplesIntervalMs()` Returns the number of milliseconds between two consecutive rows of this data stream.
`double`	`get_firstDataSamplesInterval()`
`double`	`get_maxValue()` Returns the largest measure observed within this stream.
`double`	`get_minValue()` Returns the smallest measure observed within this stream.
`double`	`get_realDuration()`
`double`	`get_realStartTimeUTC()` Returns the start time of the data stream, relative to the Jan 1, 1970.
`int`	`get_rowCount()` Returns the number of data rows present in this stream.
`int`	`get_runIndex()` Returns the run index of the data stream.
`int`	`get_startTime()` Returns the relative start time of the data stream, measured in seconds.
`long`	`get_startTimeUTC()` Returns the start time of the data stream, relative to the Jan 1, 1970.
`boolean`	`isClosed()`
`int`	`loadStream()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATA_INVALID
```
public static final double DATA_INVALID
```
    See Also:
    
    Constant Field Values
  - _parent
```
protected YFunction _parent
```
  - _runNo
```
protected int _runNo
```
  - _utcStamp
```
protected long _utcStamp
```
  - _nCols
```
protected int _nCols
```
  - _nRows
```
protected int _nRows
```
  - _startTime
```
protected double _startTime
```
  - _duration
```
protected double _duration
```
  - _dataSamplesInterval
```
protected double _dataSamplesInterval
```
  - _firstMeasureDuration
```
protected double _firstMeasureDuration
```
  - _columnNames
```
protected ArrayList<String> _columnNames
```
  - _functionId
```
protected String _functionId
```
  - _isClosed
```
protected boolean _isClosed
```
  - _isAvg
```
protected boolean _isAvg
```
  - _minVal
```
protected double _minVal
```
  - _avgVal
```
protected double _avgVal
```
  - _maxVal
```
protected double _maxVal
```
  - _values
```
protected ArrayList<ArrayList<Double>> _values
```
  - _isLoaded
```
protected boolean _isLoaded
```
  - _calhdl
```
protected YAPI.CalibrationHandlerCallback _calhdl
```
- Method Detail
  - _parseCalibArr
```
public int _parseCalibArr(ArrayList<Integer> iCalib)
```
  - _initFromDataSet
```
public int _initFromDataSet(YDataSet dataset,
                            ArrayList<Integer> encoded)
```
  - _parseStream
```
public int _parseStream(byte[] sdata)
                 throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - _wasLoaded
```
public boolean _wasLoaded()
```
  - _get_url
```
public String _get_url()
```
  - _get_baseurl
```
public String _get_baseurl()
```
  - _get_urlsuffix
```
public String _get_urlsuffix()
```
  - loadStream
```
public int loadStream()
               throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - _decodeVal
```
public double _decodeVal(int w)
```
  - _decodeAvg
```
public double _decodeAvg(int dw,
                         int count)
```
  - isClosed
```
public boolean isClosed()
```
  - get_runIndex
```
public int get_runIndex()
```
    Returns the run index of the data stream. A run can be made of multiple datastreams, for different time intervals.
    
    Returns:
    
    an unsigned number corresponding to the run index.
  - 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_realStartTimeUTC(). DEPRECATED: This method has been replaced by get_realStartTimeUTC().
    
    Returns:
    
    an unsigned number corresponding to the number of seconds between the start of the run and the beginning of this data stream.
  - get_startTimeUTC
```
public long get_startTimeUTC()
```
    Returns the start time of the data stream, relative to the Jan 1, 1970. If the UTC time was not set in the datalogger at the time of the recording of this data stream, this method returns 0. DEPRECATED: This method has been replaced by get_realStartTimeUTC().
    
    Returns:
    
    an unsigned number corresponding to the number of seconds between the Jan 1, 1970 and the beginning of this data stream (i.e. Unix time representation of the absolute time).
  - get_realStartTimeUTC
```
public double get_realStartTimeUTC()
```
    Returns the start time of the data stream, relative to the Jan 1, 1970. If the UTC time was not set in the datalogger at the time of the recording of this data stream, this method returns 0.
    
    Returns:
    
    a floating-point number corresponding to the number of seconds between the Jan 1, 1970 and the beginning of this data stream (i.e. Unix time representation of the absolute time).
  - get_dataSamplesIntervalMs
```
public int get_dataSamplesIntervalMs()
```
    Returns the number of milliseconds between two consecutive rows of this data stream. By default, the data logger records one row per second, but the recording frequency can be changed for each device function
    
    Returns:
    
    an unsigned number corresponding to a number of milliseconds.
  - get_dataSamplesInterval
```
public double get_dataSamplesInterval()
```
  - get_firstDataSamplesInterval
```
public double get_firstDataSamplesInterval()
```
  - get_rowCount
```
public int get_rowCount()
                 throws YAPI_Exception
```
    Returns the number of data rows present in this stream. If the device uses a firmware older than version 13000, this method fetches the whole data stream from the device if not yet done, which can cause a little delay.
    
    Returns:
    
    an unsigned number corresponding to the number of rows.
    
    Throws:
    
    YAPI_Exception - on error
  - get_columnCount
```
public int get_columnCount()
                    throws YAPI_Exception
```
    Returns the number of data columns present in this stream. The meaning of the values present in each column can be obtained using the method get_columnNames(). If the device uses a firmware older than version 13000, this method fetches the whole data stream from the device if not yet done, which can cause a little delay.
    
    Returns:
    
    an unsigned number corresponding to the number of columns.
    
    Throws:
    
    YAPI_Exception - on error
  - get_columnNames
```
public ArrayList<String> get_columnNames()
                                  throws YAPI_Exception
```
    Returns the title (or meaning) of each data column present in this stream. In most case, the title of the data column is the hardware identifier of the sensor that produced the data. For streams recorded at a lower recording rate, the dataLogger stores the min, average and max value during each measure interval into three columns with suffixes _min, _avg and _max respectively. If the device uses a firmware older than version 13000, this method fetches the whole data stream from the device if not yet done, which can cause a little delay.
    
    Returns:
    
    a list containing as many strings as there are columns in the data stream.
    
    Throws:
    
    YAPI_Exception - on error
  - get_minValue
```
public double get_minValue()
                    throws YAPI_Exception
```
    Returns the smallest measure observed within this stream. If the device uses a firmware older than version 13000, this method will always return YDataStream.DATA_INVALID.
    
    Returns:
    
    a floating-point number corresponding to the smallest value, or YDataStream.DATA_INVALID if the stream is not yet complete (still recording).
    
    Throws:
    
    YAPI_Exception - on error
  - get_averageValue
```
public double get_averageValue()
                        throws YAPI_Exception
```
    Returns the average of all measures observed within this stream. If the device uses a firmware older than version 13000, this method will always return YDataStream.DATA_INVALID.
    
    Returns:
    
    a floating-point number corresponding to the average value, or YDataStream.DATA_INVALID if the stream is not yet complete (still recording).
    
    Throws:
    
    YAPI_Exception - on error
  - get_maxValue
```
public double get_maxValue()
                    throws YAPI_Exception
```
    Returns the largest measure observed within this stream. If the device uses a firmware older than version 13000, this method will always return YDataStream.DATA_INVALID.
    
    Returns:
    
    a floating-point number corresponding to the largest value, or YDataStream.DATA_INVALID if the stream is not yet complete (still recording).
    
    Throws:
    
    YAPI_Exception - on error
  - get_realDuration
```
public double get_realDuration()
```
  - get_dataRows
```
public ArrayList<ArrayList<Double>> get_dataRows()
                                          throws YAPI_Exception
```
    Returns the whole data set contained in the stream, as a bidimensional table of numbers. The meaning of the values present in each column can be obtained using the method get_columnNames(). This method fetches the whole data stream from the device, if not yet done.
    
    Returns:
    
    a list containing as many elements as there are rows in the data stream. Each row itself is a list of floating-point numbers.
    
    Throws:
    
    YAPI_Exception - on error
  - get_data
```
public double get_data(int row,
                       int col)
                throws YAPI_Exception
```
    Returns a single measure from the data stream, specified by its row and column index. The meaning of the values present in each column can be obtained using the method get_columnNames(). This method fetches the whole data stream from the device, if not yet done.
    
    Parameters:
    
    row - : row index
    
    col - : column index
    
    Returns:
    
    a floating-point number
    
    Throws:
    
    YAPI_Exception - on error

Class YDataStream

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATA_INVALID

_parent

_runNo

_utcStamp

_nCols

_nRows

_startTime

_duration

_dataSamplesInterval

_firstMeasureDuration

_columnNames

_functionId

_isClosed

_isAvg

_minVal

_avgVal

_maxVal

_values

_isLoaded

_calhdl

Method Detail

_parseCalibArr

_initFromDataSet

_parseStream

_wasLoaded

_get_url

_get_baseurl

_get_urlsuffix

loadStream

_decodeVal

_decodeAvg

isClosed

get_runIndex

get_startTime

get_startTimeUTC

get_realStartTimeUTC

get_dataSamplesIntervalMs

get_dataSamplesInterval

get_firstDataSamplesInterval

get_rowCount

get_columnCount

get_columnNames

get_minValue

get_averageValue

get_maxValue

get_realDuration

get_dataRows

get_data