Package adams.flow.transformer

Class SetPlotContainerValue

  • 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 SetPlotContainerValue
extends AbstractTransformer
    Updates a value of a plot container before it is being displayed in the SequencePlotter sink. Usually, you would attach a variable to the 'value' property of this actor, in order to update the specified value of the container with a value that you calculated somewhere else in the flow.

    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: SetPlotContainerValue
 
    -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
 
    -container-value <PLOT_NAME|X_VALUE|Y_VALUE|X_ERROR_VALUE|Y_ERROR_VALUE|META_DATA> (property: containerValue)
    The type of value to update.
    default: PLOT_NAME
 
    -value <adams.core.base.BaseString> (property: value)
    The actual value to use for updating; values for X_VALUE and Y_VALUE get 
    automatically parsed to doubles; in case of PLOT_NAME you can also use variables 
    in the string.
    default: Plot
 
    -meta-data-key <java.lang.String> (property: metaDataKey)
    The key to use when updating meta-data.
    default: 
 
    -conversion <adams.data.conversion.ConversionFromString> (property: conversion)
    The conversion to apply to the meta-data value string before adding it.
    default: adams.data.conversion.StringToString
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SetPlotContainerValue

        public SetPlotContainerValue()

    • Method Detail

      • containerValueTipText

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

      • setValue

        public void setValue​(BaseString value)
        Sets the value to use for updating.
        Parameters:
        value - the actual value

      • getValue

        public BaseString getValue()
        Returns the value to use for updating.
        Returns:
        the value

      • valueTipText

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

      • setMetaDataKey

        public void setMetaDataKey​(String value)
        Sets the meta-data key to use.
        Parameters:
        value - the key

      • getMetaDataKey

        public String getMetaDataKey()
        Returns the meta-data key to use.
        Returns:
        the key

      • metaDataKeyTipText

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

      • setConversion

        public void setConversion​(ConversionFromString value)
        Sets the conversion to apply to the meta-data value string.
        Parameters:
        value - the conversion

      • getConversion

        public ConversionFromString getConversion()
        Returns the conversion to apply to the meta-data value string.
        Returns:
        the conversion

      • conversionTipText

        public String conversionTipText()
        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:
        adams.flow.container.SequencePlotterContainer.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