Package de.gsi.dataset.testdata.spi

Class AbstractTestFunction<D extends AbstractTestFunction<D>>

java.lang.Object

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

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

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

de.gsi.dataset.testdata.spi.AbstractTestFunction<D>

Type Parameters:

D - generics for fluent design

All Implemented Interfaces:

DataSet, DataSetError, DataSetMetaData, EventSource, TestDataSet<D>

Direct Known Subclasses:

CosineFunction, GaussFunction, RandomStepFunction, RandomWalkFunction, SincFunction, SineFunction, SingleOutlierFunction

public abstract class AbstractTestFunction<D extends AbstractTestFunction<D>>
extends AbstractErrorDataSet<D>
implements TestDataSet<D>

abstract error data set for graphical testing purposes

Author:

rstein

Nested Class Summary

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

DataSetError.ErrorType

Field Summary

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

dataLabels, dataStyles, editConstraints, lock, metaInfoMap, name, updateListeners, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor	Description
AbstractTestFunction(java.lang.String name, int count)

Method Summary

Modifier and Type	Method	Description
double[]	generateX(int count)	generate test data set
int	getDataCount()	Get the number of data points in the data set
DataSetError.ErrorType	getErrorType()	return the DataSetError.ErrorType of the dataset
java.lang.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.
D	update()	generate a new set of numbers

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

computeLimits, fireInvalidated, getThis, lock, setErrorType, unlock

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

addDataLabel, addDataStyle, binarySearchX, binarySearchY, getDataCount, getDataLabel, getDefaultDataLabel, getEditConstraints, getErrorList, getInfoList, getMetaInfo, getName, getUndefValue, getWarningList, getXIndex, getXMax, getXMin, getXRange, getYIndex, getYMax, getYMin, getYRange, isAutoNotification, minNeigbourSearchX, removeDataLabel, removeStyle, setAutoNotifaction, setEditConstraints, setName, toString, 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.DataSet

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

Methods inherited from interface de.gsi.dataset.DataSetError

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

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

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Methods inherited from interface de.gsi.dataset.testdata.TestDataSet

fireInvalidated, generateY

Constructor Detail

AbstractTestFunction

public AbstractTestFunction(java.lang.String name,
                            int count)

Parameters:

name - data set name

count - number of samples

Method Detail

update

public D update()

Description copied from interface: TestDataSet

generate a new set of numbers

Specified by:

update in interface TestDataSet<D extends AbstractTestFunction<D>>

Returns:

itself (fluent design)

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

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

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

getErrorType

public DataSetError.ErrorType getErrorType()

Description copied from class: AbstractErrorDataSet

return the DataSetError.ErrorType of the dataset

Specified by:

getErrorType in interface DataSetError

Overrides:

getErrorType in class AbstractErrorDataSet<D extends AbstractTestFunction<D>>

Returns:

one of the error types specified in ErrorType

See Also:

for details

getStyle

public java.lang.String getStyle(int index)

Description copied from class: AbstractDataSet

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

Specified by:

getStyle in interface DataSet

Overrides:

getStyle in class AbstractDataSet<D extends AbstractTestFunction<D>>

Parameters:

index - the index of the specific data point

Returns:

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

generateX

public double[] generateX(int count)

Description copied from interface: TestDataSet

generate test data set

Specified by:

generateX in interface TestDataSet<D extends AbstractTestFunction<D>>

Parameters:

count - number of bins

Returns:

the generated array