org.lsst.ccs.plugin.jas3.trending

Class Plot

java.lang.Object

org.lsst.ccs.plugin.jas3.trending.Plot

All Implemented Interfaces:

hep.aida.IDataPointSet

public final class Plot
extends Object
implements hep.aida.IDataPointSet

Plotted data for a single channel with additional bookkeeping references. An object of this type can be passed to a plotter and will be plotted as a data point set. It also contains additional plottable data that may or may not be displayed depending on plotter settings, as well as references to components where it is plotted. In addition to its current dataset, an instance of this class may keep a reference to an updated data point set. During construction, the current data point set is supplied and the updated data point set is null. Later, the updated data point set can be set through a call to one of the refresh(PlotData, ...) methods. Calling commitRefresh() replaces current data point set with the updated one, creating the latter if it has not been set since the previous call to refresh(). Methods modifying data sets of the Plot instance are synchronized on its monitor.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
Plot(PlotData data, TimeWindow timeWindow, DataChannelHandler channel)
Plot(PlotData data, TimeWindow timeWindow, DataChannelHandler channel, org.freehep.jas.services.PlotPage page, org.freehep.jas.services.PlotRegion region)

Method Summary

Modifier and Type	Method and Description
hep.aida.IDataPoint	addPoint()
void	addPoint(hep.aida.IDataPoint idp)
hep.aida.IAnnotation	annotation()
void	clear()
boolean	commitRefresh() Replaces current plot data with updated plot data, creating the latter if necessary.
int	dimension()
DataChannelHandler	getChannel() Returns data channel used to populate this dataset.
double	getGranularity() Returns average time interval between points in this dataset, in milliseconds.
org.freehep.jas.services.PlotPage	getPage() Returns the page where this dataset is plotted.
org.freehep.jas.services.PlotRegion	getRegion() Returns the region where this dataset is plotted.
long	getTimeStamp() Returns the time of construction or last call to refresh(...).
TimeWindow	getTimeWindow() Returns time window associated with this dataset.
void	hideExtra()
double	lowerExtent(int i)
hep.aida.IDataPoint	point(int i)
void	refresh(PlotData data) Sets updated data for this plot.
void	refresh(PlotData data, long begin, long end) Sets updated data for this plot.
void	removePoint(int i)
void	scale(double d)
void	scaleErrors(double d)
void	scaleValues(double d)
void	setCoordinate(int i, double[] doubles, double[] doubles1)
void	setCoordinate(int i, double[] doubles, double[] doubles1, double[] doubles2)
void	setPage(org.freehep.jas.services.PlotPage page) Associates a page with this dataset.
void	setRegion(org.freehep.jas.services.PlotRegion region) Associates a region with this dataset.
void	setTimeRange(long begin, long end) Sets the range of this data point set along time axis.
void	setTitle(String string)
void	showExtra()
int	size()
String	title()
double	upperExtent(int i)

Methods inherited from class java.lang.Object

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

Constructor Detail

Plot

public Plot(PlotData data,
            TimeWindow timeWindow,
            DataChannelHandler channel)

Plot

public Plot(PlotData data,
            TimeWindow timeWindow,
            DataChannelHandler channel,
            org.freehep.jas.services.PlotPage page,
            org.freehep.jas.services.PlotRegion region)

Method Detail

getTimeStamp

public long getTimeStamp()

Returns the time of construction or last call to refresh(...).

getTimeWindow

public TimeWindow getTimeWindow()

Returns time window associated with this dataset.

getChannel

public DataChannelHandler getChannel()

Returns data channel used to populate this dataset.

getPage

public org.freehep.jas.services.PlotPage getPage()

Returns the page where this dataset is plotted.

setPage

public void setPage(org.freehep.jas.services.PlotPage page)

Associates a page with this dataset.

getRegion

public org.freehep.jas.services.PlotRegion getRegion()

Returns the region where this dataset is plotted.

setRegion

public void setRegion(org.freehep.jas.services.PlotRegion region)

Associates a region with this dataset.

setTimeRange

public void setTimeRange(long begin,
                         long end)

Sets the range of this data point set along time axis. The edges of the range can be later retrieved with lowerExtent(int) and upperExtent(int) methods. Setting the time range does not affect TimeWindow object associated with this data point set.

Parameters:

begin - Beginning of the range in milliseconds.

end - End of the range in milliseconds.

getGranularity

public double getGranularity()

Returns average time interval between points in this dataset, in milliseconds.

commitRefresh

public boolean commitRefresh()

Replaces current plot data with updated plot data, creating the latter if necessary.

Returns:

True if the current data point set has changed as a result of this call.

refresh

public void refresh(PlotData data)

Sets updated data for this plot. Time range is calculated based on the content of the supplied data point set.

refresh

public void refresh(PlotData data,
                    long begin,
                    long end)

Sets updated data for this plot.

showExtra

public void showExtra()

hideExtra

public void hideExtra()

annotation

public hep.aida.IAnnotation annotation()

Specified by:

annotation in interface hep.aida.IDataPointSet

title

public String title()

Specified by:

title in interface hep.aida.IDataPointSet

setTitle

public void setTitle(String string)
              throws IllegalArgumentException

Specified by:

setTitle in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

dimension

public int dimension()

Specified by:

dimension in interface hep.aida.IDataPointSet

clear

public void clear()

Specified by:

clear in interface hep.aida.IDataPointSet

size

public int size()

Specified by:

size in interface hep.aida.IDataPointSet

point

public hep.aida.IDataPoint point(int i)

Specified by:

point in interface hep.aida.IDataPointSet

setCoordinate

public void setCoordinate(int i,
                          double[] doubles,
                          double[] doubles1)
                   throws IllegalArgumentException

Specified by:

setCoordinate in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

setCoordinate

public void setCoordinate(int i,
                          double[] doubles,
                          double[] doubles1,
                          double[] doubles2)
                   throws IllegalArgumentException

Specified by:

setCoordinate in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

addPoint

public hep.aida.IDataPoint addPoint()
                             throws RuntimeException

Specified by:

addPoint in interface hep.aida.IDataPointSet

Throws:

RuntimeException

addPoint

public void addPoint(hep.aida.IDataPoint idp)
              throws IllegalArgumentException

Specified by:

addPoint in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

removePoint

public void removePoint(int i)
                 throws IllegalArgumentException

Specified by:

removePoint in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

lowerExtent

public double lowerExtent(int i)
                   throws IllegalArgumentException

Specified by:

lowerExtent in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

upperExtent

public double upperExtent(int i)
                   throws IllegalArgumentException

Specified by:

upperExtent in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

scale

public void scale(double d)
           throws IllegalArgumentException

Specified by:

scale in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

scaleValues

public void scaleValues(double d)
                 throws IllegalArgumentException

Specified by:

scaleValues in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException

scaleErrors

public void scaleErrors(double d)
                 throws IllegalArgumentException

Specified by:

scaleErrors in interface hep.aida.IDataPointSet

Throws:

IllegalArgumentException