org.lsst.ccs.gconsole.plugins.trending

Class PlotMaker

java.lang.Object

org.lsst.ccs.gconsole.plugins.trending.PlotMaker

public class PlotMaker
extends Object

Machinery for making and updating plots.

Public methods of this class can be called from any thread, the actual plotting is done on the AWT event processing thread. If called on the event processing thread, these methods execute synchronously and return when the plotting is finished. Otherwise, they prepare the data for plotting, schedule a plotting task on the event processing thread, and return immediately.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlotMaker.Options

Method Summary

Modifier and Type	Method and Description
void	plot(DataChannelHandler channel, TimeWindow timeWindow, boolean useExistingPlot, boolean newPage, boolean newPlot, boolean overlay) Plots time history for the specified channel.
void	refresh(DataChannelHandler channel, TimeWindow timeWindow) Refreshes all regions where the specified channel data is plotted.
void	refresh(org.freehep.jas.services.PlotPage page, TimeWindow timeWindow) Refreshes all regions on the specified page.
void	refresh(org.freehep.jas.services.PlotRegion region, TimeWindow timeWindow, PlotMaker.Options... options) Refreshes plots in the specified region.

Methods inherited from class java.lang.Object

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

Method Detail

plot

public void plot(DataChannelHandler channel,
                 TimeWindow timeWindow,
                 boolean useExistingPlot,
                 boolean newPage,
                 boolean newPlot,
                 boolean overlay)

Plots time history for the specified channel.

Parameters:

channel - Data channel to be plotted.

timeWindow - Time window. If null, currently selected time window is used.

useExistingPlot - If true, the new plot will replace an existing plot for the same channel if possible. See DataChannelHandler.findPlot(...) for details on how the plot to be replaced is chosen.

newPage - If true, the plot will be shown in a new page unless an existing plot is being replaced.

newPlot - If true, the plot will be shown in a new region on the current page unless an existing plot is being replaced.

overlay - If true, the plot will be overlaid on top of the current region.

refresh

public void refresh(DataChannelHandler channel,
                    TimeWindow timeWindow)

Refreshes all regions where the specified channel data is plotted.

Parameters:

channel - Data channel.

timeWindow - Time window for the new plots. If null, time windows already associated with plots being refreshed are used.

refresh

public void refresh(org.freehep.jas.services.PlotPage page,
                    TimeWindow timeWindow)

Refreshes all regions on the specified page.

Parameters:

page - Plot page.

timeWindow - Time window for the new plots. If null, time windows already associated with plots being refreshed are used.

refresh

public void refresh(org.freehep.jas.services.PlotRegion region,
                    TimeWindow timeWindow,
                    PlotMaker.Options... options)

Refreshes plots in the specified region.

Parameters:

region - Plot region.

timeWindow - Time window for the new plots. If null, time windows already associated with plots being refreshed are used.

options - Additional options. If no options are given, this method will only refresh plots with sliding time windows, and re-plot regions with refreshed plots. Specifying REFRESH_ALL or REFRESH_NONE options results in re-fetching data for all or none of the plots, respectively. FORCE_REPLOT option guarantees that the region is redrawn whether or not any plots it contains have been refreshed.