adams.flow.sink
Class GnuplotScript

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.sink.AbstractSink
                  adams.flow.sink.AbstractFileWriter
                      adams.flow.sink.AbstractAppendableFileWriter
                          adams.flow.sink.GnuplotScript

All Implemented Interfaces:

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

public class GnuplotScript
extends AbstractAppendableFileWriter

Actor for generating Gnuplot script files for plotting data stored in the data file that is received as input.

Input/output:
- accepts:
java.lang.String
java.io.File

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: GnuplotScript
 

-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.
 

-output <adams.core.io.PlaceholderFile> (property: outputFile)
    The name of the Gnuplot script file.
    default: .
 

-append (property: append)
    If set to true, scripts gets only appended.
 

-scriptlet <adams.core.gnuplot.AbstractScriptlet> (property: scriptlet)
    The scriplet to use for producing the Gnuplot script for plotting the data.
    default: adams.core.gnuplot.CustomScriptlet
 

Version:

$Revision: 4913 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractScriptlet

m_Scriptlet the script generator to use.

Fields inherited from class adams.flow.sink.AbstractAppendableFileWriter

m_Append

Fields inherited from class adams.flow.sink.AbstractFileWriter

m_OutputFile

Fields inherited from class adams.flow.sink.AbstractSink

BACKUP_INPUT, m_InputToken

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

GnuplotScript()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	appendTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
AbstractScriptlet	getScriptlet() Returns the scriptlet in use.
String	globalInfo() Returns a string describing the object.
String	outputFileTipText() Returns the tip text for this property.
String	scriptletTipText() Returns the tip text for this property.
void	setScriptlet(AbstractScriptlet value) Sets the scriptlet to use.

Methods inherited from class adams.flow.sink.AbstractAppendableFileWriter

getAppend, getQuickInfo, setAppend

Methods inherited from class adams.flow.sink.AbstractFileWriter

getDefaultOutputFile, getOutputFile, setOutputFile, setUp

Methods inherited from class adams.flow.sink.AbstractSink

backupState, input, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, 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, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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_Scriptlet

protected AbstractScriptlet m_Scriptlet

the script generator to use.

Constructor Detail

GnuplotScript

public GnuplotScript()

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 AbstractAppendableFileWriter

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in class AbstractFileWriter

Returns:

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

appendTipText

public String appendTipText()

Returns the tip text for this property.

Specified by:

appendTipText in class AbstractAppendableFileWriter

Returns:

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

setScriptlet

public void setScriptlet(AbstractScriptlet value)

Sets the scriptlet to use.

Parameters:

value - the scriptlet

getScriptlet

public AbstractScriptlet getScriptlet()

Returns the scriptlet in use.

Returns:

the scriplet

scriptletTipText

public String scriptletTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

java.lang.String.class, java.io.File.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message