Package adams.flow.standalone.rats.generator

Class AbstractRatGenerator

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    AbstractScript, AbstractScriptedRatGenerator, Dummy
    public abstract class AbstractRatGenerator
extends adams.core.option.AbstractOptionHandler
    Ancestor for generators that create Rat setups.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.core.CallableActorReference m_Log
      the callable name.
      protected adams.flow.control.StorageName m_SendErrorQueue
      the name of the (optional) queue in internal storage for sending send error to.
      protected boolean m_ShowInControl
      whether to show in RatControl.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void check()
      Hook method for checks.
      void defineOptions()
      Adds options to the internal list of options.
      protected abstract Rat[] doGenerate()
      Generates the actual setups.
      Rat[] generate()
      Generates Rat setups.
      adams.flow.core.CallableActorReference getLog()
      Returns the name of the callable log actor in use.
      adams.flow.control.StorageName getSendErrorQueue()
      Returns the name for the queue in internal storage to feed with send errors.
      boolean getShowInControl()
      Returns whether to show in RatControl.
      String logTipText()
      Returns the tip text for this property.
      String sendErrorQueueTipText()
      Returns the tip text for this property.
      void setLog​(adams.flow.core.CallableActorReference value)
      Sets the name of the callable log actor to use.
      void setSendErrorQueue​(adams.flow.control.StorageName value)
      Sets the name for the queue in internal storage to feed with send errors.
      void setShowInControl​(boolean value)
      Sets whether to show in RatControl.
      String showInControlTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Log

        protected adams.flow.core.CallableActorReference m_Log
        the callable name.

      • m_SendErrorQueue

        protected adams.flow.control.StorageName m_SendErrorQueue
        the name of the (optional) queue in internal storage for sending send error to.

      • m_ShowInControl

        protected boolean m_ShowInControl
        whether to show in RatControl.

    • Constructor Detail

      • AbstractRatGenerator

        public AbstractRatGenerator()

    • Method Detail

      • 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

      • setLog

        public void setLog​(adams.flow.core.CallableActorReference value)
        Sets the name of the callable log actor to use.
        Parameters:
        value - the callable name

      • getLog

        public adams.flow.core.CallableActorReference getLog()
        Returns the name of the callable log actor in use.
        Returns:
        the callable name

      • logTipText

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

      • setSendErrorQueue

        public void setSendErrorQueue​(adams.flow.control.StorageName value)
        Sets the name for the queue in internal storage to feed with send errors.
        Parameters:
        value - the name

      • getSendErrorQueue

        public adams.flow.control.StorageName getSendErrorQueue()
        Returns the name for the queue in internal storage to feed with send errors.
        Returns:
        the name

      • sendErrorQueueTipText

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

      • setShowInControl

        public void setShowInControl​(boolean value)
        Sets whether to show in RatControl.
        Parameters:
        value - true if to show in RatControl

      • getShowInControl

        public boolean getShowInControl()
        Returns whether to show in RatControl.
        Returns:
        true if to show in RatControl

      • showInControlTipText

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

      • check

        protected void check()
        Hook method for checks.

        Default implementation does nothing.

      • doGenerate

        protected abstract Rat[] doGenerate()
        Generates the actual setups.
        Returns:
        the generated setups

      • generate

        public Rat[] generate()
        Generates Rat setups.
        Returns:
        the setups