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_ReflTransPlot
,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 boolean
ABREV_SYNOPSIS
AbstractOutputTypeArgs
abstractOutputTypeArgs
java.lang.String[]
cmdLineArgs
static java.lang.String
OPTIONS_HEADING
protected java.util.Properties
toolProps
-
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.Integer
call()
Computes a result, or throws an exception if unable to do so.static java.util.Properties
configDefaults()
abstract void
destroy()
static void
endGmtAndCleanUp(java.io.PrintWriter out)
java.util.List<java.lang.String>
getCmdLineArgs()
java.lang.String
getOutFileExtension()
abstract java.lang.String
getOutputFormat()
abstract void
init()
boolean
isDEBUG()
boolean
isVerbose()
void
setDEBUG(boolean debug)
Turns on debugging output.void
setOutFileBase(java.lang.String outFileBase)
void
setOutFileExtension(java.lang.String outFileExtension)
void
setOutputFormat(java.lang.String val)
usually one of TEXT or JSON.void
setToolPropsFilename(java.lang.String filename)
void
setVerbose(boolean verbose)
Turns on verbose output.abstract void
start()
static java.lang.String
toolNameFromClass(java.lang.Class toolClass)
abstract void
validateArguments()
-
-
-
Field Detail
-
cmdLineArgs
public java.lang.String[] cmdLineArgs
-
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.Exception
Computes a result, or throws an exception if unable to do so.- Specified by:
call
in 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.
-
isDEBUG
public boolean isDEBUG()
-
setVerbose
public void setVerbose(boolean verbose)
Turns on verbose output.
-
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)
-
endGmtAndCleanUp
public static void endGmtAndCleanUp(java.io.PrintWriter out)
-
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.IOException
TauPException
-
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
-
-