Package adams.core.gnuplot

Class Pause

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.ErrorProvider, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class Pause
extends AbstractScriptlet
    Inserts a pause statement to keep the plot open; the use needs to press the enter key in the terminal to close the plot. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -waiting-period <int> (property: waitingPeriod)
    The waiting period in seconds before closing the plot automatically; use 
    -1 to keep open indefinitely.
    default: -1
    minimum: -1
 
    -message <java.lang.String> (property: message)
    The message to output in the terminal when pausing, ignored if empty.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_WaitingPeriod

        protected int m_WaitingPeriod
        the time in seconds to wait before the plot closes.

      • m_Message

        protected String m_Message
        the message to display in the terminal.

    • Constructor Detail

      • Pause

        public Pause()

    • 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

      • setWaitingPeriod

        public void setWaitingPeriod​(int value)
        Sets the waiting period in seconds before closing the plot.
        Parameters:
        value - the waiting period, use -1 for indefinite

      • getWaitingPeriod

        public int getWaitingPeriod()
        Returns the waiting period in seconds before closing the plot.
        Returns:
        the waiting period, -1 if indefinite

      • waitingPeriodTipText

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

      • setMessage

        public void setMessage​(String value)
        Sets the message to display in the terminal when pausing.
        Parameters:
        value - the message to display

      • getMessage

        public String getMessage()
        Returns the message to display in the terminal when pausing.
        Returns:
        the message to display

      • messageTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractScriptlet
        Returns:
        null if no info available, otherwise short string

      • doGenerate

        protected String doGenerate()
        Generates the actual script code.
        Specified by:
        doGenerate in class AbstractScriptlet
        Returns:
        the script code, null in case of an error