Package adams.flow.standalone.rats.output

Class Switch

  • 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 Switch
extends AbstractRatOutput
    Forwards the input data to the sub-branch of the condition that evaluates to 'true'. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -condition <adams.flow.condition.bool.BooleanCondition> [-condition ...] (property: conditions)
    The switch conditions to evaluate - the first condition that evaluates to 
    'true' triggers the execution of the corresponding 'case' actor.
    default: 
 
    -case <adams.flow.standalone.rats.RatOutput> [-case ...] (property: cases)
    The transmitters to send the data to.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Conditions

        protected adams.flow.condition.bool.BooleanCondition[] m_Conditions
        the "conditions" for the various switch cases.

    • Constructor Detail

      • Switch

        public Switch()

    • 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 adams.core.option.AbstractOptionHandler

      • setConditions

        public void setConditions​(adams.flow.condition.bool.BooleanCondition[] value)
        Sets the conditions to evaluate.
        Parameters:
        value - the conditions

      • getConditions

        public adams.flow.condition.bool.BooleanCondition[] getConditions()
        Returns the conditions to evaluate.
        Returns:
        the conditions

      • conditionsTipText

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

      • setCases

        public void setCases​(RatOutput[] value)
        Sets the base transmitters to use.
        Parameters:
        value - the transmitters

      • getCases

        public RatOutput[] getCases()
        Returns the base transmitters to use.
        Returns:
        the transmitters

      • casesTipText

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

      • setUp

        public String setUp()
        Hook method for performing checks at setup time.
        Specified by:
        setUp in interface RatOutput
        Overrides:
        setUp in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message

      • doTransmit

        protected String doTransmit()
        Performs the actual transmission.
        Specified by:
        doTransmit in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message