Package adams.flow.standalone.rats.output

Class ContainerValuePicker

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable
    public class ContainerValuePicker
extends AbstractMetaRatOutput
    Extracts the specified value from the container and passes this on to the base rat output scheme. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -output <adams.flow.standalone.rats.RatOutput> (property: output)
    The transmitter to wrap.
    default: adams.flow.standalone.rats.DummyOutput
 
    -value <java.lang.String> (property: valueName)
    The name of the value to extract.
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ValueName

        protected String m_ValueName
        the value to pick.

    • Constructor Detail

      • ContainerValuePicker

        public ContainerValuePicker()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractMetaRatOutput

      • setValueName

        public void setValueName​(String value)
        Sets the name of the value to tee off.
        Parameters:
        value - the name

      • getValueName

        public String getValueName()
        Returns the name of the value to tee off.
        Returns:
        the name

      • valueNameTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractMetaRatOutput
        Returns:
        null if no info available, otherwise short string

      • callTransmit

        protected String callTransmit()
        Hook method that calls the base-input's transmit() method.
        Overrides:
        callTransmit in class AbstractMetaRatOutput
        Returns:
        null if successful, otherwise error message