org.simbrain.plot.timeseries

Class TimeSeriesModel

java.lang.Object

org.simbrain.plot.ChartModel

org.simbrain.plot.timeseries.TimeSeriesModel

public class TimeSeriesModel
extends ChartModel

Data model for a time series plot.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesModel() Time series model constructor.
TimeSeriesModel(int numDataSources) Initialize model to specified number of data sources.

Method Summary

Modifier and Type	Method and Description
void	addData(int dataSourceIndex, double time, double value) Add data to this model.
void	addDataSource() Adds a data source to the chart.
void	addDataSources(int numDataSources) Create specified number of set of data sources.
void	clearData() Clears the plot.
void	defaultInit() Default plot initialization.
org.jfree.data.xy.XYSeriesCollection	getDataset()
double	getRangeLowerBound()
double	getRangeUpperBound()
int	getWindowSize()
static com.thoughtworks.xstream.XStream	getXStream() Returns a properly initialized xstream object.
boolean	isAutoRange()
boolean	isFixedWidth()
void	removeDataSource() Removes a data source from the chart.
void	setAutoRange(boolean autoRange)
void	setFixedWidth(boolean fixedWidth)
void	setRangeLowerBound(double lowerRangeBoundary)
void	setRangeUpperBound(double upperBound)
void	setWindowSize(int windowSize)
void	update() Update the model; currently used to remove unused data when in "fixed width" mode.

Methods inherited from class org.simbrain.plot.ChartModel

addChartSettingsListener, addListener, fireChartInitialized, fireDataSourceAdded, fireDataSourceRemoved, fireSettingsChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesModel

public TimeSeriesModel()

Time series model constructor.

TimeSeriesModel

public TimeSeriesModel(int numDataSources)

Initialize model to specified number of data sources.

Parameters:

numDataSources -

Method Detail

defaultInit

public void defaultInit()

Default plot initialization.

addDataSources

public void addDataSources(int numDataSources)

Create specified number of set of data sources. Adds these two existing data sources.

Parameters:

numDataSources - number of data sources to initialize plot with

clearData

public void clearData()

Clears the plot.

removeDataSource

public void removeDataSource()

Removes a data source from the chart.

addDataSource

public void addDataSource()

Adds a data source to the chart.

getDataset

public org.jfree.data.xy.XYSeriesCollection getDataset()

Returns:

JFreeChart data set.

getXStream

public static com.thoughtworks.xstream.XStream getXStream()

Returns a properly initialized xstream object.

Returns:

the XStream object

isFixedWidth

public boolean isFixedWidth()

Returns:

the fixedWidth

setFixedWidth

public void setFixedWidth(boolean fixedWidth)

Parameters:

fixedWidth - the fixedWidth to set

getWindowSize

public int getWindowSize()

Returns:

the windowSize

setWindowSize

public void setWindowSize(int windowSize)

Parameters:

windowSize - the windowSize to set

isAutoRange

public boolean isAutoRange()

Returns:

the autoRange

setAutoRange

public void setAutoRange(boolean autoRange)

Parameters:

autoRange - the autoRange to set

getRangeUpperBound

public double getRangeUpperBound()

Returns:

the upperRangeBoundary

setRangeUpperBound

public void setRangeUpperBound(double upperBound)

Parameters:

upperBound - the upperRangeBoundary to set

getRangeLowerBound

public double getRangeLowerBound()

Returns:

the lowerRangeBoundary

setRangeLowerBound

public void setRangeLowerBound(double lowerRangeBoundary)

Parameters:

lowerRangeBoundary - the lowerRangeBoundary to set

addData

public void addData(int dataSourceIndex,
                    double time,
                    double value)

Add data to this model.

Parameters:

dataSourceIndex - index of data source to use

time - data for x axis

value - data for y axis

update

public void update()

Update the model; currently used to remove unused data when in "fixed width" mode.