Package uk.ac.starlink.ttools.plottask
Class PlotTask
- java.lang.Object
-
- uk.ac.starlink.ttools.plottask.PlotTask
-
- All Implemented Interfaces:
uk.ac.starlink.task.Task
- Direct Known Subclasses:
TableHistogram
,TablePlot2D
,TablePlot3D
public abstract class PlotTask extends java.lang.Object implements uk.ac.starlink.task.Task
Abstract superclass for tasks which generate plots from table data.- Since:
- 22 Apr 2008
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description PlotTask(java.lang.String purpose, PlotStateFactory stateFactory, TablePlot plot)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description uk.ac.starlink.task.Executable
createExecutable(uk.ac.starlink.task.Environment env)
protected java.util.List<uk.ac.starlink.task.Parameter>
getParameterList()
uk.ac.starlink.task.Parameter[]
getParameters()
java.lang.String
getPurpose()
uk.ac.starlink.task.Parameter
getXpixParameter()
Returns the parameter used for setting plot output X dimension.uk.ac.starlink.task.Parameter
getYpixParameter()
Returns the parameter used for setting plot output Y dimension.
-
-
-
Constructor Detail
-
PlotTask
public PlotTask(java.lang.String purpose, PlotStateFactory stateFactory, TablePlot plot)
Constructor.- Parameters:
purpose
- short (one-line) task purposestateFactory
- PlotStateFactory for use with this plotplot
- plot component for use with this plot
-
-
Method Detail
-
getParameterList
protected java.util.List<uk.ac.starlink.task.Parameter> getParameterList()
-
getPurpose
public java.lang.String getPurpose()
- Specified by:
getPurpose
in interfaceuk.ac.starlink.task.Task
-
getParameters
public uk.ac.starlink.task.Parameter[] getParameters()
- Specified by:
getParameters
in interfaceuk.ac.starlink.task.Task
-
getXpixParameter
public uk.ac.starlink.task.Parameter getXpixParameter()
Returns the parameter used for setting plot output X dimension.- Returns:
- xpix parameter
-
getYpixParameter
public uk.ac.starlink.task.Parameter getYpixParameter()
Returns the parameter used for setting plot output Y dimension.- Returns:
- ypix parameter
-
createExecutable
public uk.ac.starlink.task.Executable createExecutable(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
- Specified by:
createExecutable
in interfaceuk.ac.starlink.task.Task
- Throws:
uk.ac.starlink.task.TaskException
-
-