Package adams.flow.standalone.rats.generator

Class Scripted

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.scripting.FileBasedScripting, adams.core.scripting.FileBasedScriptingWithOptions, adams.core.SizeOfHandler, Serializable
    public class Scripted
extends AbstractScriptedRatGenerator
    A rat generator that uses any scripting handler for generating the rat actor(s) with a script located in the specified file. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -log <adams.flow.core.CallableActorReference> (property: log)
    The name of the callable log actor to use (logging disabled if actor not
    found).
    default: unknown
 
    -send-error-queue <adams.flow.control.StorageName> (property: sendErrorQueue)
    The name of the (optional) queue in internal storage to feed with send errors.
    default: senderrors
 
    -show-in-control <boolean> (property: showInControl)
    If enabled, the generated Rat will be displayed in the adams.flow.standalone.RatControl
    control panel.
    default: false
 
    -script <adams.core.io.PlaceholderFile> (property: scriptFile)
    The script file to load and execute.
    default: ${CWD}
 
    -options <adams.core.base.BaseText> (property: scriptOptions)
    The options for the script; must consist of 'key=value' pairs separated
    by blanks; the value of 'key' can be accessed via the 'getAdditionalOptions
    ().getXYZ("key")' method in the script actor.
    default:
 
    -handler <adams.core.scripting.AbstractScriptingHandler> (property: handler)
    The handler to use for scripting.
    default: adams.core.scripting.Dummy
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_GeneratorObject

        protected transient AbstractRatGenerator m_GeneratorObject
        the loaded script object.

      • m_Handler

        protected adams.core.scripting.AbstractScriptingHandler m_Handler
        the scripting handler to use.

    • Constructor Detail

      • Scripted

        public Scripted()

    • 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 AbstractScriptedRatGenerator

      • scriptOptionsTipText

        public String scriptOptionsTipText()
        Returns the tip text for this property.
        Specified by:
        scriptOptionsTipText in interface adams.core.scripting.FileBasedScriptingWithOptions
        Overrides:
        scriptOptionsTipText in class AbstractScriptedRatGenerator
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setHandler

        public void setHandler​(adams.core.scripting.AbstractScriptingHandler value)
        Sets the handler to use for scripting.
        Parameters:
        value - the handler

      • getHandler

        public adams.core.scripting.AbstractScriptingHandler getHandler()
        Gets the handler to use for scripting.
        Returns:
        the handler

      • handlerTipText

        public String handlerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • destroy

        public void destroy()
        Frees up memory in a "destructive" non-reversible way.
        Specified by:
        destroy in interface adams.core.Destroyable
        Overrides:
        destroy in class AbstractScriptedRatGenerator