Package etomica.graphics

Class DisplayPlot

java.lang.Object

etomica.graphics.Display

etomica.graphics.DisplayPlot

All Implemented Interfaces:

DataSetListener

public class DisplayPlot
extends Display
implements DataSetListener

Class for creating a plot of simulation data. Data for plot is taken from a DataSet instance, which can be obtained via the getDataSet method. Data sets are added to the plot by piping the data to a new DataSink obtained from the makeDataSink method in DataSet. The incoming data must be either a DataFunction or a DataGroup of DataFunctions. A DataGroup of DataFunctions will be plotted as separate sets of data in the plot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisplayPlot.DataWriter	Writes a file with the raw data from a plot.
static class	DisplayPlot.PopupListener
static class	DisplayPlot.RawDataWindowOpener	Opens a window with the raw data from a plot.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSet	dataSet
protected boolean	doClear
protected java.util.LinkedList<DataTagBag>	drawLineList
protected java.util.LinkedList<DataTagBag>	labelList
protected boolean	logWarn
protected javax.swing.JPanel	panel
protected EtomicaPlot	plot
protected java.util.LinkedList<DataTagBag>	unitList
protected java.lang.String	xLabel

Fields inherited from class etomica.graphics.Display

label, support

Constructor Summary

Constructors

Constructor	Description
DisplayPlot()	Creates a plot with a new, empty, DataSinkTable.
DisplayPlot(DataSet dataSet)	Creates a plot using data from the given table.

Method Summary

Modifier and Type	Method	Description
void	dataChanged(DataSet changedDataSet)	Causes the display of the plot to be updated.
void	dataCountChanged(DataSet changedDataSet)	Updates the units array for the new column, using the default units.
void	doUpdate()	Redraws the plot.
protected IData	getDataFromSet(DataTag[] tags)
DataSet	getDataSet()	Returns the DataSinkTable instance that specifies the plot data.
EtomicaPlot	getPlot()	Accessor method to plot class so that its properties can be edited.
java.awt.Component	graphic()	Overrides superclass method to return a JPanel holding the plot.
boolean	isDoClear()
boolean	isDoLegend()	Accessor for flag determining if a legend is to be shown.
void	setDoClear(boolean newDoClear)
void	setDoDrawLines(DataTag[] dataTags, boolean doDrawLines)	Sets the data set corresponding to the given tags to be have the data points connected with lines or not.
void	setDoLegend(boolean b)	Mutator for flag determining if a legend is to be shown.
void	setLegend(DataTag[] dataTags, java.lang.String label)
void	setSize(int width, int height)	Sets the drawn size of the plot
void	setUnit(DataTag[] dataTags, Unit newUnit)
void	setUnit(Unit newUnit)
void	setXLabel(java.lang.String newXLabel)
void	setXUnit(Unit u)	Extend superclass method to update label with change of unit.

Methods inherited from class etomica.graphics.Display

addPropertyChangeListener, getLabel, removePropertyChangeListener, setLabel, toString

Methods inherited from class java.lang.Object

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

Field Detail

dataSet

protected final DataSet dataSet

plot

protected final EtomicaPlot plot

labelList

protected final java.util.LinkedList<DataTagBag> labelList

unitList

protected final java.util.LinkedList<DataTagBag> unitList

drawLineList

protected final java.util.LinkedList<DataTagBag> drawLineList

panel

protected final javax.swing.JPanel panel

doClear

protected boolean doClear

xLabel

protected java.lang.String xLabel

logWarn

protected boolean logWarn

Constructor Detail

DisplayPlot

public DisplayPlot()

Creates a plot with a new, empty, DataSinkTable.

DisplayPlot

public DisplayPlot(DataSet dataSet)

Creates a plot using data from the given table.

Method Detail

getDataSet

public DataSet getDataSet()

Returns the DataSinkTable instance that specifies the plot data. Data sets are added to the plot by piping them to a new data sink given by the makeColumn method of the table.

Returns:

dataChanged

public void dataChanged(DataSet changedDataSet)

Causes the display of the plot to be updated.

Specified by:

dataChanged in interface DataSetListener

dataCountChanged

public void dataCountChanged(DataSet changedDataSet)

Updates the units array for the new column, using the default units.

Specified by:

dataCountChanged in interface DataSetListener

Parameters:

changedDataSet - the Data object that has been added

doUpdate

public void doUpdate()

Redraws the plot.

setDoLegend

public void setDoLegend(boolean b)

Mutator for flag determining if a legend is to be shown. Default is true.

getDataFromSet

protected IData getDataFromSet(DataTag[] tags)

isDoLegend

public boolean isDoLegend()

Accessor for flag determining if a legend is to be shown. Default is true.

setLegend

public void setLegend(DataTag[] dataTags,
                      java.lang.String label)

setDoClear

public void setDoClear(boolean newDoClear)

isDoClear

public boolean isDoClear()

setDoDrawLines

public void setDoDrawLines(DataTag[] dataTags,
                           boolean doDrawLines)

Sets the data set corresponding to the given tags to be have the data points connected with lines or not.

getPlot

public final EtomicaPlot getPlot()

Accessor method to plot class so that its properties can be edited.

graphic

public java.awt.Component graphic()

Overrides superclass method to return a JPanel holding the plot.

Specified by:

graphic in class Display

setXUnit

public void setXUnit(Unit u)

Extend superclass method to update label with change of unit.

setXLabel

public void setXLabel(java.lang.String newXLabel)

setUnit

public void setUnit(DataTag[] dataTags,
                    Unit newUnit)

setUnit

public void setUnit(Unit newUnit)

setSize

public void setSize(int width,
                    int height)

Sets the drawn size of the plot

Parameters:

width - new width, in pixels

height - new height, in pixels