Package adams.flow.standalone.rats.output

Class EnQueue

  • 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 EnQueue
extends AbstractRatOutput
implements adams.flow.control.StorageUpdater
    Enqueues the incoming data in the specified queue in internal storage. 

    -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
 
    -guard <adams.flow.standalone.rats.output.enqueue.AbstractEnqueueGuard> (property: guard)
    The guard for enqueuing the data.
    default: adams.flow.standalone.rats.output.enqueue.PassThrough
    Author:
    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_RetrievalDelay

        protected long m_RetrievalDelay
        the retrieval delay in msecs.

    • Constructor Detail

      • EnQueue

        public EnQueue()

    • 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

      • setStorageName

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

      • getStorageName

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

      • storageNameTipText

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

      • setGuard

        public void setGuard​(AbstractEnqueueGuard value)
        Sets the guard for enqueuing the data.
        Parameters:
        value - the guard

      • getGuard

        public AbstractEnqueueGuard getGuard()
        Returns the guard for enqueuing the data.
        Returns:
        the guard

      • guardTipText

        public String guardTipText()
        Returns the tip text for this property.
        Returns:
        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
        Returns:
        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
        Overrides:
        getQuickInfo in class AbstractRatOutput
        Returns:
        null if no info available, otherwise short string

      • setRetrievalDelay

        public void setRetrievalDelay​(long value)
        Sets the delay to enforce on the retrieval of objects from the queue.
        Parameters:
        value - the delay

      • getRetrievalDelay

        public long getRetrievalDelay()
        Returns the delay to enforce on the retrieval of objects from the queue.
        Returns:
        the delay

      • retrievalDelayTipText

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

      • doTransmit

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