com.yoctopuce.YoctoAPI

Class YConsolidatedDataSet

java.lang.Object

com.yoctopuce.YoctoAPI.YConsolidatedDataSet

public class YConsolidatedDataSet
extends Object

YConsolidatedDataSet Class: Cross-sensor consolidated data sequence. YConsolidatedDataSet objects make it possible to retrieve a set of recorded measures from multiple sensors, for a specified time interval. They can be used to load data points progressively, and to receive data records by timestamp, one by one..

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<YDataSet>	_datasets
protected double	_end
protected ArrayList<Integer>	_nextidx
protected ArrayList<Double>	_nexttim
protected int	_nsensors
protected ArrayList<Integer>	_progresss
protected ArrayList<YSensor>	_sensors
protected double	_start

Constructor Summary

Constructors

Constructor and Description
YConsolidatedDataSet(double startTime, double endTime, ArrayList<YSensor> sensorList)

Method Summary

Modifier and Type	Method and Description
int	imm_init(double startt, double endt, ArrayList<YSensor> sensorList)
static YConsolidatedDataSet	Init(ArrayList<String> sensorNames, double startTime, double endTime) Returns an object holding historical data for multiple sensors, for a specified time interval.
int	nextRecord(ArrayList<Double> datarec) Extracts the next data record from the data logger of all sensors linked to this object.

Methods inherited from class java.lang.Object

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

Field Detail

_start

protected double _start

_end

protected double _end

_nsensors

protected int _nsensors

_sensors

protected ArrayList<YSensor> _sensors

_datasets

protected ArrayList<YDataSet> _datasets

_progresss

protected ArrayList<Integer> _progresss

_nextidx

protected ArrayList<Integer> _nextidx

_nexttim

protected ArrayList<Double> _nexttim

Constructor Detail

YConsolidatedDataSet

public YConsolidatedDataSet(double startTime,
                            double endTime,
                            ArrayList<YSensor> sensorList)

Method Detail

imm_init

public int imm_init(double startt,
                    double endt,
                    ArrayList<YSensor> sensorList)

Init

public static YConsolidatedDataSet Init(ArrayList<String> sensorNames,
                                        double startTime,
                                        double endTime)
                                 throws YAPI_Exception

Returns an object holding historical data for multiple sensors, for a specified time interval. The measures will be retrieved from the data logger, which must have been turned on at the desired time. The resulting object makes it possible to load progressively a large set of measures from multiple sensors, consolidating data on the fly to align records based on measurement timestamps.

Parameters:

sensorNames - : array of logical names or hardware identifiers of the sensors for which data must be loaded from their data logger.

startTime - : the start of the desired measure time interval, as a Unix timestamp, i.e. the number of seconds since January 1, 1970 UTC. The special value 0 can be used to include any measure, without initial limit.

endTime - : the end of the desired measure time interval, as a Unix timestamp, i.e. the number of seconds since January 1, 1970 UTC. The special value 0 can be used to include any measure, without ending limit.

Returns:

an instance of YConsolidatedDataSet, providing access to consolidated historical data. Records can be loaded progressively using the YConsolidatedDataSet.nextRecord() method.

Throws:

YAPI_Exception

nextRecord

public int nextRecord(ArrayList<Double> datarec)
               throws YAPI_Exception

Extracts the next data record from the data logger of all sensors linked to this object.

Parameters:

datarec - : array of floating point numbers, that will be filled by the function with the timestamp of the measure in first position, followed by the measured value in next positions.

Returns:

an integer in the range 0 to 100 (percentage of completion), or a negative error code in case of failure.

Throws:

YAPI_Exception - on error