Class QueueDistribute

  • 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, adams.flow.control.StorageUpdater, RatOutput, Serializable

    public class QueueDistribute
    extends AbstractRatOutput
    implements adams.flow.control.StorageUpdater
    Enqueues the incoming data in the queues in internal storage, performing load-balancing by iterating through them.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -storage-name <adams.flow.control.StorageName> [-storage-name ...] (property: storageNames)
        The names of the queues in the internal storage.
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_StorageNames

        protected adams.flow.control.StorageName[] m_StorageNames
        the names of the queues in the internal storage.
      • m_Current

        protected int m_Current
        the current queue to serve.
    • Constructor Detail

      • QueueDistribute

        public QueueDistribute()
    • 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
        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
        defineOptions in class adams.core.option.AbstractOptionHandler
      • reset

        protected void reset()
        Resets the scheme.
        reset in class adams.core.option.AbstractOptionHandler
      • setStorageNames

        public void setStorageNames​(adams.flow.control.StorageName[] value)
        Sets the names for the queues in the internal storage.
        value - the names
      • getStorageNames

        public adams.flow.control.StorageName[] getStorageNames()
        Returns the names for the queues in the internal storage.
        the names
      • storageNamesTipText

        public String storageNamesTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • isUpdatingStorage

        public boolean isUpdatingStorage()
        Returns whether storage items are being updated.
        Specified by:
        isUpdatingStorage in interface adams.flow.control.StorageUpdater
        true if storage items are updated
      • 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
        getQuickInfo in class AbstractRatOutput
        null if no info available, otherwise short string
      • check

        protected String check()
        Hook method for performing checks.
        check in class AbstractRatOutput
        null if successful, otherwise error message
      • doTransmit

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