Package etomica.data.history

Class HistoryScrolling

java.lang.Object

etomica.data.history.HistoryScrolling

All Implemented Interfaces:

History, java.io.Serializable

Direct Known Subclasses:

HistoryStatistics

public class HistoryScrolling
extends java.lang.Object
implements History, java.io.Serializable

History that records a number of values, with new ones replacing the earliest ones when the record is full. The data returned by the getHistory method will have the earliest first in the array, and the most recent last. If presented as a plot, the effect will be to scroll the data across the plot window.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cursor
protected boolean	full
protected double[]	history
protected double[]	tempX
protected double[]	tempY
protected double[]	xValues

Constructor Summary

Constructors

Constructor	Description
HistoryScrolling()
HistoryScrolling(int n)

Method Summary

Modifier and Type	Method	Description
boolean	addValue(double x, double y)	Adds the given x, y pair to the History.
double[]	getHistory()	Returns an array with the most recent history at the end.
int	getHistoryLength()	Returns the number of data points tracked by the History.
int	getSampleCount()	Returns the number of data samples currently held by the History.
double[]	getXValues()	Returns an array containing the x values that have been added to the History.
void	reset()	Removes entire history, setting all values to NaN.
void	setHistoryLength(int n)	Sets the number of values kept in the history.
boolean	willDiscardNextData()

Methods inherited from class java.lang.Object

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

Field Detail

history

protected double[] history

cursor

protected int cursor

tempY

protected double[] tempY

tempX

protected double[] tempX

xValues

protected double[] xValues

full

protected boolean full

Constructor Detail

HistoryScrolling

public HistoryScrolling()

HistoryScrolling

public HistoryScrolling(int n)

Method Detail

setHistoryLength

public void setHistoryLength(int n)

Sets the number of values kept in the history.

Specified by:

setHistoryLength in interface History

getHistoryLength

public int getHistoryLength()

Description copied from interface: History

Returns the number of data points tracked by the History.

Specified by:

getHistoryLength in interface History

getSampleCount

public int getSampleCount()

Description copied from interface: History

Returns the number of data samples currently held by the History.

Specified by:

getSampleCount in interface History

reset

public void reset()

Removes entire history, setting all values to NaN.

Specified by:

reset in interface History

getXValues

public double[] getXValues()

Description copied from interface: History

Returns an array containing the x values that have been added to the History.

Specified by:

getXValues in interface History

addValue

public boolean addValue(double x,
                        double y)

Description copied from interface: History

Adds the given x, y pair to the History. Returns true if getHistory will now return different values.

Specified by:

addValue in interface History

getHistory

public double[] getHistory()

Returns an array with the most recent history at the end.

Specified by:

getHistory in interface History

willDiscardNextData

public boolean willDiscardNextData()