org.eclipse.eavp.viz.service.csv

Class PlotProvider

java.lang.Object

org.eclipse.eavp.viz.service.csv.PlotProvider

public class PlotProvider
extends java.lang.Object

The provider for the plot which will include plot attributes and a structure for the series

Author:

Matthew Wang, Kasper Gammeltoft - Viz refactor to use ISeries rather than SeriesProvider

Constructor Summary

Constructors

Constructor and Description
PlotProvider() Default constructor
PlotProvider(java.lang.String newPlotTitle) A comprehensive constructor that takes in a plot title

Method Summary

Modifier and Type	Method and Description
void	addSeries(double time, ISeries newSeries) Adds a new ISeries to the specified time
ISeries	getIndependentSeries()
XYZPlotStyle	getPlotStyle() Accessor for the plot style
java.lang.String	getPlotTitle() Accessor for the plot title
java.util.ArrayList<ISeries>	getSeriesAtTime(double time) Returns all the series at a specified time
java.util.ArrayList<java.lang.Double>	getTimes() Accessor for the times
java.lang.String	getTimeUnits() Accessor for the plot's time units
XYZAxisStyle	getXAxisStyle() Accessor for the plot's x axis style
XYZAxisStyle	getYAxisStyle() Accessor for the plot's y axis style
boolean	isContour() Method to check if this plotProvider is a contour
void	removeSeries(double time, ISeries oldSeries) Removes an existing SeriesProvider from the specified time.
void	setIndependentSeries(ISeries indptSeries) Sets the independent series to provide.
void	setPlotAsContour() Sets the plot to be drawn as a contour map rather than a series plot
void	setPlotStyle(XYZPlotStyle newStyle) Sets the XYZPlotStyle for the plot, which is read in by the editor and applied appropriately.
void	setPlotTitle(java.lang.String newTitle) Mutator for the plot title
void	setTimeUnits(java.lang.String newUnit)
void	setXAxisStyle(XYZAxisStyle newStyle) Sets the x axis style for the plot.
void	setYAxisStyle(XYZAxisStyle newStyle) Sets the y axis style for the plot

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotProvider

public PlotProvider()

Default constructor

PlotProvider

public PlotProvider(java.lang.String newPlotTitle)

A comprehensive constructor that takes in a plot title

Method Detail

addSeries

public void addSeries(double time,
                      ISeries newSeries)

Adds a new ISeries to the specified time

Parameters:

time -

newSeries -

getIndependentSeries

public ISeries getIndependentSeries()

getPlotStyle

public XYZPlotStyle getPlotStyle()

Accessor for the plot style

Returns:

getPlotTitle

public java.lang.String getPlotTitle()

Accessor for the plot title

Returns:

getSeriesAtTime

public java.util.ArrayList<ISeries> getSeriesAtTime(double time)

Returns all the series at a specified time

Parameters:

time -

Returns:

getTimes

public java.util.ArrayList<java.lang.Double> getTimes()

Accessor for the times

Returns:

getTimeUnits

public java.lang.String getTimeUnits()

Accessor for the plot's time units

Returns:

getXAxisStyle

public XYZAxisStyle getXAxisStyle()

Accessor for the plot's x axis style

Returns:

getYAxisStyle

public XYZAxisStyle getYAxisStyle()

Accessor for the plot's y axis style

Returns:

isContour

public boolean isContour()

Method to check if this plotProvider is a contour

Returns:

removeSeries

public void removeSeries(double time,
                         ISeries oldSeries)

Removes an existing SeriesProvider from the specified time. Does nothing if the arguments are invalid.

Parameters:

time - The time at which the series should be removed.

oldSeries - The series that should be removed.

setIndependentSeries

public void setIndependentSeries(ISeries indptSeries)

Sets the independent series to provide. Must not be null.

Parameters:

indptSeries - The ISeries to provide.

setPlotAsContour

public void setPlotAsContour()

Sets the plot to be drawn as a contour map rather than a series plot

setPlotStyle

public void setPlotStyle(XYZPlotStyle newStyle)

Sets the XYZPlotStyle for the plot, which is read in by the editor and applied appropriately.

Parameters:

newStyle -

setPlotTitle

public void setPlotTitle(java.lang.String newTitle)

Mutator for the plot title

Parameters:

plotTitle -

setTimeUnits

public void setTimeUnits(java.lang.String newUnit)

Parameters:

timeUnits -

setXAxisStyle

public void setXAxisStyle(XYZAxisStyle newStyle)

Sets the x axis style for the plot.

Parameters:

newStyle -

setYAxisStyle

public void setYAxisStyle(XYZAxisStyle newStyle)

Sets the y axis style for the plot

Parameters:

newStyle -