Class EnqueueGenerator

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

    public class EnqueueGenerator
    extends AbstractOutInterceptorGenerator<Enqueue>
    Generator for Enqueue.
    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 queue to enqueue the token in.
      • m_EnqueueMessage

        protected boolean m_EnqueueMessage
        whether to enqueue the message or just a NullToken.
    • Constructor Detail

      • EnqueueGenerator

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

        public void setStorageName​(adams.flow.control.StorageName value)
        Sets the queue to use.
        Parameters:
        value - the queue
      • getStorageName

        public adams.flow.control.StorageName getStorageName()
        Returns the queue in use.
        Returns:
        the queue
      • 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.
      • setEnqueueMessage

        public void setEnqueueMessage​(boolean value)
        Sets whether to enqueue the whole message or just a NullToken.
        Parameters:
        value - true if to enqueue whole message
      • getEnqueueMessage

        public boolean getEnqueueMessage()
        Returns whether to enqueue the whole message or just a NullToken.
        Returns:
        true if to enqueue whole message
      • enqueueMessageTipText

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