Class DeQueue

  • 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<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.flow.control.StorageUpdater, RatInput, Serializable

    public class DeQueue
    extends AbstractRatInput
    implements adams.flow.control.StorageUpdater
    Polls the specified queue in internal storage for an item, blocks till an item is available.

    -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> (property: storageName)
        The name of the queue in the internal storage.
        default: queue
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_StorageName

        protected adams.flow.control.StorageName m_StorageName
        the name of the queue in the internal storage.
      • m_Output

        protected Object m_Output
        the item obtained from the queue.
      • m_PollTimeout

        protected int m_PollTimeout
        the internal timeout interval for polling the queue in msec.
      • m_Queue

        protected transient adams.flow.control.StorageQueueHandler m_Queue
        the current queue.
    • Constructor Detail

      • DeQueue

        public DeQueue()
    • 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
      • setStorageName

        public void setStorageName​(adams.flow.control.StorageName value)
        Sets the name for the queue in the internal storage.
        value - the name
      • getStorageName

        public adams.flow.control.StorageName getStorageName()
        Returns the name for the queue in the internal storage.
        the name
      • storageNameTipText

        public String storageNameTipText()
        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 AbstractRatInput
        null if no info available, otherwise short string
      • poll

        protected Object poll​(adams.flow.control.StorageQueueHandler queue)
        Waits for the next data object, polling the queue.
        the data, null if none available (eg when stopped)
      • doReceive

        protected String doReceive()
        Performs the actual reception of data.
        Specified by:
        doReceive in class AbstractRatInput
        null if successful, otherwise error message