Package uk.ac.starlink.ttools.plottask

Class Plot3DStateFactory

  • public class Plot3DStateFactory
extends PlotStateFactory
    PlotStateFactory for 3D plots.
    Since:
    20 Oct 2008
    Author:
    Mark Taylor

    • Constructor Detail

      • Plot3DStateFactory

        public Plot3DStateFactory​(java.lang.String[] dimNames,
                          boolean useAux,
                          boolean useLabel,
                          int errNdim)
        Constructor.
        Parameters:
        dimNames - names of main plot dimensions (typically "X", "Y", etc);
        useAux - whether auxiliary axes are used
        useLabel - whether point text labelling is used
        errNdim - number of axes for which errors can be plotted

    • Method Detail

      • getParameters

        public uk.ac.starlink.task.Parameter<?>[] getParameters()
        Description copied from class: PlotStateFactory
        Returns the parameters associated with this object. The returned list is intended for external use in documentation; the parameter objects returned may or may not be those used for obtaining values from a particular execution environment. For this reason they may have names which are symbolic, that is, represent possible parameter names. Since actual parameter names are dynamically determined from other parameter names, it is not possible to return an exhaustive list.
        Overrides:
        getParameters in class PlotStateFactory
        Returns:
        array of parameters to be used for documentation

      • configurePlotState

        protected void configurePlotState​(PlotState state,
                                  uk.ac.starlink.task.Environment env)
                           throws uk.ac.starlink.task.TaskException
        Description copied from class: PlotStateFactory
        Configures a PlotState object by examining parameter values in a given execution environment. Such an object was presumably previously created by a call to PlotStateFactory.createPlotState().
        Overrides:
        configurePlotState in class PlotStateFactory
        Parameters:
        state - plot state to configure
        env - execution environment
        Throws:
        uk.ac.starlink.task.TaskException