Package edu.sc.seis.TauP.cmdline
Class TauP_Tool
- java.lang.Object
-
- edu.sc.seis.TauP.cmdline.TauP_Tool
-
- All Implemented Interfaces:
java.util.concurrent.Callable<java.lang.Integer>
- Direct Known Subclasses:
TauP_AbstractPhaseTool,TauP_Create,TauP_DistAz,TauP_ReflTransPlot,TauP_Table,TauP_VelocityDison,TauP_VelocityMerge,TauP_VelocityPlot,TauP_Version,TauP_WebServe
public abstract class TauP_Tool extends java.lang.Object implements java.util.concurrent.Callable<java.lang.Integer>Base class for tools within the TauP Toolkit.
-
-
Field Summary
Fields Modifier and Type Field Description static booleanABREV_SYNOPSISAbstractOutputTypeArgsabstractOutputTypeArgsstatic java.lang.StringOPTIONS_HEADINGprotected java.util.PropertiestoolProps
-
Constructor Summary
Constructors Constructor Description TauP_Tool(AbstractOutputTypeArgs outputTypeArgs)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Integercall()Computes a result, or throws an exception if unable to do so.static java.util.PropertiesconfigDefaults()abstract voiddestroy()java.util.List<java.lang.String>getCmdLineArgs()java.lang.StringgetOutFileExtension()abstract java.lang.StringgetOutputFormat()abstract voidinit()booleanisDEBUG()booleanisVerbose()voidsetDEBUG(boolean debug)Turns on debugging output.voidsetOutFileBase(java.lang.String outFileBase)voidsetOutFileExtension(java.lang.String outFileExtension)voidsetOutputFormat(java.lang.String val)usually one of TEXT or JSON.voidsetToolPropsFilename(java.lang.String filename)voidsetVerbose(boolean verbose)Turns on verbose output.abstract voidstart()static java.lang.StringtoolNameFromClass(java.lang.Class toolClass)abstract voidvalidateArguments()
-
-
-
Field Detail
-
toolProps
protected java.util.Properties toolProps
-
abstractOutputTypeArgs
public AbstractOutputTypeArgs abstractOutputTypeArgs
-
OPTIONS_HEADING
public static final java.lang.String OPTIONS_HEADING
- See Also:
- Constant Field Values
-
ABREV_SYNOPSIS
public static final boolean ABREV_SYNOPSIS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TauP_Tool
public TauP_Tool(AbstractOutputTypeArgs outputTypeArgs)
-
-
Method Detail
-
call
public java.lang.Integer call() throws java.lang.ExceptionComputes a result, or throws an exception if unable to do so.- Specified by:
callin interfacejava.util.concurrent.Callable<java.lang.Integer>- Returns:
- computed result
- Throws:
java.lang.Exception- if unable to compute a result
-
setDEBUG
public void setDEBUG(boolean debug)
Turns on debugging output.- Parameters:
debug- on or off
-
isDEBUG
public boolean isDEBUG()
-
setVerbose
public void setVerbose(boolean verbose)
Turns on verbose output.- Parameters:
verbose- on or off
-
isVerbose
public boolean isVerbose()
-
getCmdLineArgs
public java.util.List<java.lang.String> getCmdLineArgs()
-
configDefaults
public static java.util.Properties configDefaults()
-
getOutputFormat
public abstract java.lang.String getOutputFormat()
-
setOutputFormat
public void setOutputFormat(java.lang.String val)
usually one of TEXT or JSON. Subclasses may add additional types, for example CSV, GMT or SVG.- Parameters:
val- output format for results
-
setOutFileBase
public void setOutFileBase(java.lang.String outFileBase)
-
getOutFileExtension
public java.lang.String getOutFileExtension()
-
setOutFileExtension
public void setOutFileExtension(java.lang.String outFileExtension)
-
setToolPropsFilename
public void setToolPropsFilename(java.lang.String filename) throws java.io.IOException- Throws:
java.io.IOException
-
init
public abstract void init() throws TauPException- Throws:
TauPException
-
start
public abstract void start() throws java.io.IOException, TauPException- Throws:
java.io.IOExceptionTauPException
-
destroy
public abstract void destroy() throws TauPException- Throws:
TauPException
-
toolNameFromClass
public static java.lang.String toolNameFromClass(java.lang.Class toolClass)
-
validateArguments
public abstract void validateArguments() throws TauPException- Throws:
TauPException
-
-