de.gsi.dataset.spi

Class FifoDoubleErrorDataSet

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<D>

de.gsi.dataset.spi.AbstractErrorDataSet<DoubleErrorDataSet>

de.gsi.dataset.spi.FifoDoubleErrorDataSet

All Implemented Interfaces:

DataSet, DataSetError, DataSetMetaData, EventSource

public class FifoDoubleErrorDataSet
extends AbstractErrorDataSet<DoubleErrorDataSet>
implements DataSetError

Author:

rstein

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FifoDoubleErrorDataSet.DataBlob
class	FifoDoubleErrorDataSet.LimitedQueue<E>

Nested classes/interfaces inherited from interface de.gsi.dataset.DataSetError

DataSetError.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
protected FifoDoubleErrorDataSet.LimitedQueue<FifoDoubleErrorDataSet.DataBlob>	data
protected double	maxDistance

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

lock, name, updateListeners, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
FifoDoubleErrorDataSet(String name, int initalSize) Creates a new instance of FifoDoubleErrorDataSet.
FifoDoubleErrorDataSet(String name, int initalSize, double maxDistance) Creates a new instance of FifoDoubleErrorDataSet.

Method Summary

Modifier and Type	Method and Description
FifoDoubleErrorDataSet	add(double[] xValues, double[] yValues, double[] yErrorsNeg, double[] yErrorsPos) Initialises the data set with specified data.
FifoDoubleErrorDataSet	add(double x, double y, double yErrorNeg, double yErrorPos) Add point to the DoublePoints object
FifoDoubleErrorDataSet	add(double x, double y, double yErrorNeg, double yErrorPos, String tag) Add point to the DoublePoints object
FifoDoubleErrorDataSet	add(double x, double y, double yErrorNeg, double yErrorPos, String tag, String style) Add point to the DoublePoints object
int	expire(double now) expire data points that are older than now minus length of the buffer, notifies a 'fireInvalidated()' in case data has been removed
int	getDataCount() Get the number of data points in the data set
String	getDataLabel(int index) Returns label of a data point specified by the index.
double	getMaxDistance()
String	getStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
double	getX(int index) Gets the x value of the data point with the index i
double	getXErrorNegative(int index) Returns the negative error along the X axis of a point specified by the index.
double	getXErrorPositive(int index) Returns the positive error along the X axis of a point specified by the index.
double	getY(int index) Gets the y value of the data point with the index i
double	getYErrorNegative(int index) Returns the negative error along the Y axis of a point specified by the index.
double	getYErrorPositive(int index) Returns the positive error along the Y axis of a point specified by the index.
void	reset() remove all data points
void	setMaxDistance(double maxDistance)

Methods inherited from class de.gsi.dataset.spi.AbstractErrorDataSet

computeLimits, getErrorType, getThis, setErrorType

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet

binarySearchX, binarySearchY, fireInvalidated, getDataCount, getErrorList, getInfoList, getMetaInfo, getName, getUndefValue, getWarningList, getXIndex, getXMax, getXMin, getXRange, getYIndex, getYMax, getYMin, getYRange, isAutoNotification, lock, minNeigbourSearchX, setAutoNotifaction, setName, toString, unlock, updateEventListener

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.dataset.DataSetError

getErrorType, getXErrorNegative, getXErrorPositive, getXErrorsNegative, getXErrorsPositive, getYErrorNegative, getYErrorPositive, getYErrorsNegative, getYErrorsPositive

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getName, getStyle, getUndefValue, getValue, getXIndex, getXMax, getXMin, getXValues, getYIndex, getYMax, getYMin, getYValues, isAutoNotification, lock, setAutoNotifaction, setStyle, unlock

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Field Detail

data

protected FifoDoubleErrorDataSet.LimitedQueue<FifoDoubleErrorDataSet.DataBlob> data

maxDistance

protected double maxDistance

Constructor Detail

FifoDoubleErrorDataSet

public FifoDoubleErrorDataSet(String name,
                              int initalSize)

Creates a new instance of FifoDoubleErrorDataSet.

Parameters:

name - name of this DataSet.

initalSize - maximum circular buffer capacity

Throws:

IllegalArgumentException - if name is null

FifoDoubleErrorDataSet

public FifoDoubleErrorDataSet(String name,
                              int initalSize,
                              double maxDistance)

Creates a new instance of FifoDoubleErrorDataSet.

Parameters:

name - name of this DataSet.

initalSize - maximum circular buffer capacity

maxDistance - maximum range before data points are being dropped

Throws:

IllegalArgumentException - if name is null

Method Detail

getMaxDistance

public double getMaxDistance()

Returns:

maximum range before data points are being dropped

setMaxDistance

public void setMaxDistance(double maxDistance)

Parameters:

maxDistance - maximum range before data points are being dropped

getX

public double getX(int index)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

getX in interface DataSet

Parameters:

index - the index of the data point

Returns:

the x value

getY

public double getY(int index)

Description copied from interface: DataSet

Gets the y value of the data point with the index i

Specified by:

getY in interface DataSet

Parameters:

index - the index of the data point

Returns:

the y value

getStyle

public String getStyle(int index)

Description copied from interface: DataSet

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Specified by:

getStyle in interface DataSet

Parameters:

index - the index of the specific data point

Returns:

user-specific data set style description (ie. may be set by user)

getXErrorNegative

public double getXErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorNegative in interface DataSetError

Parameters:

index - of negative X error to be returned.

Returns:

negative X error

getXErrorPositive

public double getXErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorPositive in interface DataSetError

Parameters:

index - of positive X error to be returned.

Returns:

positive X error

getYErrorNegative

public double getYErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorNegative in interface DataSetError

Parameters:

index - of negative Y error to be returned.

Returns:

negative Y error

getYErrorPositive

public double getYErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorPositive in interface DataSetError

Parameters:

index - of positive Y error to be returned.

Returns:

positive Y error

getDataLabel

public String getDataLabel(int index)

Description copied from class: AbstractDataSet

Returns label of a data point specified by the index. The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Specified by:

getDataLabel in interface DataSet

Overrides:

getDataLabel in class AbstractDataSet<DoubleErrorDataSet>

Parameters:

index - data point index

Returns:

label of a data point specified by the index or null if none label has been specified for this data point.

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set

Specified by:

getDataCount in interface DataSet

Returns:

the number of data points

add

public FifoDoubleErrorDataSet add(double x,
                                  double y,
                                  double yErrorNeg,
                                  double yErrorPos)

Add point to the DoublePoints object

Parameters:

x - the new x coordinate

y - the new y coordinate

yErrorNeg - the +dy error

yErrorPos - the -dy error

Returns:

itself

add

public FifoDoubleErrorDataSet add(double x,
                                  double y,
                                  double yErrorNeg,
                                  double yErrorPos,
                                  String tag)

Add point to the DoublePoints object

Parameters:

x - the new x coordinate

y - the new y coordinate

yErrorNeg - the +dy error

yErrorPos - the -dy error

tag - the data tag

Returns:

itself

add

public FifoDoubleErrorDataSet add(double x,
                                  double y,
                                  double yErrorNeg,
                                  double yErrorPos,
                                  String tag,
                                  String style)

Add point to the DoublePoints object

Parameters:

x - the new x coordinate

y - the new y coordinate

yErrorNeg - the +dy error

yErrorPos - the -dy error

tag - the data tag

style - the data point style

Returns:

itself

add

public FifoDoubleErrorDataSet add(double[] xValues,
                                  double[] yValues,
                                  double[] yErrorsNeg,
                                  double[] yErrorsPos)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - the new x coordinates

yValues - the new y coordinates

yErrorsNeg - the +dy errors

yErrorsPos - the -dy errors

Returns:

itself

expire

public int expire(double now)

expire data points that are older than now minus length of the buffer, notifies a 'fireInvalidated()' in case data has been removed

Parameters:

now - the newest time-stamp

Returns:

number of items that have been removed

reset

public void reset()

remove all data points