adams.flow.standalone
Class Gnuplot

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.standalone.AbstractStandalone
                  adams.flow.standalone.Gnuplot

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, Serializable, Comparable

public class Gnuplot
extends AbstractStandalone

Executes Gnuplot with the specified script file.

NB: Add the absolute path to the binary, if gnuplot is not on the system's path.

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
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: Gnuplot
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-binary <java.lang.String> (property: binary)
    The Gnuplot binary to execute; use absolute path if not on system's path.
    default: gnuplot
 

-script-file <adams.core.io.PlaceholderFile> (property: scriptFile)
    The script file to execute.
    default: ${CWD}
 

Version:

$Revision: 5436 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_Binary the binary to execute.
protected PlaceholderFile	m_ScriptFile the script file to execute.

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Gnuplot()

Method Summary

String	binaryTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	getBinary() Returns the gnuplot binary to execute.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
PlaceholderFile	getScriptFile() Returns the script file to execute.
String	globalInfo() Returns a string describing the object.
String	scriptFileTipText() Returns the tip text for this property.
void	setBinary(String value) Sets the gnuplot binary to execute.
void	setScriptFile(PlaceholderFile value) Sets the script file to execute.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_Binary

protected String m_Binary

the binary to execute.

m_ScriptFile

protected PlaceholderFile m_ScriptFile

the script file to execute.

Constructor Detail

Gnuplot

public Gnuplot()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setBinary

public void setBinary(String value)

Sets the gnuplot binary to execute.

Parameters:

value - the binary

getBinary

public String getBinary()

Returns the gnuplot binary to execute.

Returns:

the binary

binaryTipText

public String binaryTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setScriptFile

public void setScriptFile(PlaceholderFile value)

Sets the script file to execute.

Parameters:

value - the script file

getScriptFile

public PlaceholderFile getScriptFile()

Returns the script file to execute.

Returns:

the script file

scriptFileTipText

public String scriptFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message