Class MakeForecastPlotContainer

  • 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 MakeForecastPlotContainer
    extends AbstractTransformer
    Creates a named containers for the SequencePlotter actor using the incoming forecasts.

    - accepts:
    - generates:

    Container information:
    - adams.flow.container.WekaForecastContainer: Model, Forecasts
    - adams.flow.container.SequencePlotterContainer: PlotName, X, Y, IsMarker

    Valid options are:

    -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: MakeForecastPlotContainer
    -annotation <adams.core.base.BaseText> (property: annotations)
        The annotations to attach to this actor.
    -skip (property: skip)
        If set to true, transformation is skipped and the input token is just forwarded 
        as it is.
    -stop-flow-on-error (property: stopFlowOnError)
        If set to true, the flow gets stopped in case this actor encounters an error;
         useful for critical actors.
    -plot-names <java.lang.String> (property: plotNames)
        The names for the plots (comma-separated list).
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_PlotNames

        protected String m_PlotNames
        the names of the plots (comma-separated list).
    • Constructor Detail

      • MakeForecastPlotContainer

        public MakeForecastPlotContainer()
    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        reset in class AbstractActor
      • setPlotNames

        public void setPlotNames​(String value)
        Sets the plot names (comma-separated list).
        value - the names
      • getPlotNames

        public String getPlotNames()
        Returns the current plot names (comma-separated list).
        the names
      • plotNamesTipText

        public String plotNamesTipText()
        Returns the tip text for this property.
        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.
      • doExecute

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

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