Package adams.flow.transformer

Class MakePlotContainer

  • 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 MakePlotContainer
extends AbstractTransformer
    Creates a named container for the SequencePlotter actor.
    In case of Double arrays arriving at the input, they must have length 2 for X and Y, 4 for X/Y/Y-Error (low/high) or 6 X/Y/X-Error (low-high)/Y-Error (low-high).
    Integer arrays can only have the length 2.
    It is also possible, depending on the plotter sink setup, to use strings for x and/or y.
    In order to force an update of the plot, overriding the current plot-updater setup, you can create a special plot container of type UPDATE and send that to the plot (can be triggered with a null-token, e.g., from a adams.flow.source.Start source). Useful if you want to take a screenshot at a specific time, but avoid costly screen refreshs.

    Input/output:
    - accepts:
       java.lang.Double
       java.lang.Double[]
       java.lang.Integer
       java.lang.Integer[]
       java.lang.String
       java.lang.String[]
       java.lang.Object[]
    - generates:
       adams.flow.container.SequencePlotterContainer


    Container information:
    - 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: MakePlotContainer
 
    -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
 
    -plot-name <java.lang.String> (property: plotName)
    The name for the plot.
    default: Plot
 
    -type <PLOT|MARKER|OVERLAY|UPDATE> (property: type)
    The type of plot container to create.
    default: PLOT
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • MakePlotContainer

        public MakePlotContainer()

    • Method Detail

      • setPlotName

        public void setPlotName​(String value)
        Sets the plot name.
        Parameters:
        value - the name

      • getPlotName

        public String getPlotName()
        Returns the current plot name.
        Returns:
        the name

      • plotNameTipText

        public String plotNameTipText()
        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.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        java.lang.Double.class, java.lang.Double[].class, java.lang.Integer.class, java.lang.Integer[].class, java.lang.String.class, java.lang.String[].class, java.lang.Object[].class

      • doExecute

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.flow.container.SequencePlotterContainer.class