Package adams.flow.control

Class PlotProcessor

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class PlotProcessor
extends AbstractTransformer
    Applies the specified processing algorithm to the stream of plot containers passing through. Injects any additionally created plot containers into the stream.

    Input/output:
    - accepts:
       adams.flow.container.SequencePlotterContainer
    - generates:
       adams.flow.container.SequencePlotterContainer


    Container information:
    - adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
    - adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: PlotProcessor
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -processor <adams.flow.control.plotprocessor.AbstractPlotProcessor> (property: processor)
    The plot processor to apply to the stream of plot containers passing through.
    default: adams.flow.control.plotprocessor.PassThrough
 
    -type <PLOT|MARKER|OVERLAY|UPDATE> (property: type)
    The type of plot container to create.
    default: OVERLAY
 
    -drop-input <boolean> (property: dropInput)
    If enabled, then the input plot container is dropped.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • BACKUP_ADDITIONALOUTPUT

        public static final String BACKUP_ADDITIONALOUTPUT
        the key for storing the additional output tokens in the backup.
        See Also:
        Constant Field Values

      • m_DropInput

        protected boolean m_DropInput
        whether to drop the input.

      • m_AdditionalOutputTokens

        protected List<Token> m_AdditionalOutputTokens
        the additional container tokens that were generated.

    • Constructor Detail

      • PlotProcessor

        public PlotProcessor()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setProcessor

        public void setProcessor​(AbstractPlotProcessor value)
        Sets the processor to apply to the plot containers.
        Parameters:
        value - the processor

      • getProcessor

        public AbstractPlotProcessor getProcessor()
        Returns the processor to apply to the plot containers.
        Returns:
        the processor

      • processorTipText

        public String processorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • typeTipText

        public String typeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setDropInput

        public void setDropInput​(boolean value)
        Sets whether to drop the input plot container completely.
        Parameters:
        value - true if to drop input

      • getDropInput

        public boolean getDropInput()
        Returns whether to drop the input plot container completely.
        Returns:
        true if input dropped

      • dropInputTipText

        public String dropInputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message