adams.core.gnuplot
Class Pause

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.core.gnuplot.AbstractScriptlet
              adams.core.gnuplot.Pause

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable

public class Pause
extends AbstractScriptlet

Pauses the plotting.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-data-file <adams.core.io.PlaceholderFile> (property: dataFile)
    The data file to use as basis for the plot.
    default: .
 

-terminal <java.lang.String> (property: terminal)
    The terminal to use: e.g., 'x11', 'gif', 'png', 'svg'; for any terminal
    type apart from 'x11', an output file needs to be supplied.
    default: x11
 

-output <adams.core.io.PlaceholderFile> (property: outputFile)
    The output file to use if terminal other than 'x11' is used.
    default: .
 

-title <java.lang.String> (property: title)
    The title to use for the plot.
    default:
 

-x-label <java.lang.String> (property: XLabel)
    The title for the X axis; gets ignored if empty.
    default:
 

-y-label <java.lang.String> (property: YLabel)
    The title for the Y axis; gets ignored if empty.
    default:
 

-z-label <java.lang.String> (property: ZLabel)
    The title for the Z axis; gets ignored if empty.
    default:
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_Message the message to display in the terminal.
protected int	m_WaitingPeriod the time in seconds to wait before the plot closes.
static String	TERMINAL_X11 the 'x11' terminal.

Fields inherited from class adams.core.gnuplot.AbstractScriptlet

COMMENT, m_DataFile, m_LastError

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Pause()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	doGenerate() Generates the actual script code.
String	getMessage() Returns the message to display in the terminal when pausing.
int	getWaitingPeriod() Returns the waiting period in seconds before closing the plot.
String	globalInfo() Returns a string describing the object.
String	messageTipText() Returns the tip text for this property.
void	setMessage(String value) Sets the message to display in the terminal when pausing.
void	setWaitingPeriod(int value) Sets the waiting period in seconds before closing the plot.
String	waitingPeriodTipText() Returns the tip text for this property.

Methods inherited from class adams.core.gnuplot.AbstractScriptlet

check, dataFileTipText, generate, getDataFile, getLastError, hasLastError, reset, setDataFile

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TERMINAL_X11

public static final String TERMINAL_X11

the 'x11' terminal.

See Also:

Constant Field Values

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 class 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 OptionHandler

Overrides:

defineOptions in class AbstractScriptlet

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

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