public abstract class TauP_Tool
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static boolean |
DEBUG
Turns on debugging output.
|
static boolean |
expert
Turns on expert mode.
|
static java.lang.String |
JSON |
protected java.lang.String |
outFileBase |
protected Outputs |
outForms |
java.lang.String |
outputFormat |
static java.lang.String |
TEXT |
protected java.util.Properties |
toolProps |
boolean |
verbose
Turns on verbose output.
|
protected java.io.PrintWriter |
writer |
Modifier | Constructor and Description |
---|---|
protected |
TauP_Tool() |
Modifier and Type | Method and Description |
---|---|
static boolean |
dashEquals(java.lang.String argName,
java.lang.String arg) |
abstract void |
destroy() |
void |
endGmtAndCleanUp(java.io.PrintWriter out,
java.lang.String psFile,
java.lang.String projectionType) |
java.lang.String |
getOutFile() |
java.lang.String |
getOutFileBase() |
java.lang.String |
getOutFileExtension() |
java.lang.String |
getOutputFormat() |
java.io.PrintWriter |
getWriter() |
abstract void |
init() |
protected abstract java.lang.String[] |
parseCmdLineArgs(java.lang.String[] origArgs) |
protected java.lang.String[] |
parseCommonCmdLineArgs(java.lang.String[] origArgs) |
static void |
printNoComprendoArgs(java.lang.String[] noComprendoArgs) |
void |
printScriptBeginning(java.io.PrintWriter out)
a noop that allows overriding classes to print things
before results are calculated.
|
static void |
printStdUsageHead(java.lang.Class toolClass) |
static void |
printStdUsageTail() |
abstract void |
printUsage() |
void |
setOutFileBase(java.lang.String outFileBase) |
void |
setOutFileExtension(java.lang.String outFileExtension) |
void |
setOutputFormat(java.lang.String val)
usually one of TauP_Time.TEXT or TauP_Time.JSON.
|
void |
setWriter(java.io.PrintWriter writer) |
abstract void |
start() |
static java.lang.String |
toolNameFromClass(java.lang.Class toolClass) |
public static boolean DEBUG
public boolean verbose
public java.lang.String outputFormat
protected java.lang.String outFileBase
public static final java.lang.String JSON
public static final java.lang.String TEXT
public static boolean expert
protected java.io.PrintWriter writer
protected java.util.Properties toolProps
protected Outputs outForms
public java.lang.String getOutputFormat()
public void setOutputFormat(java.lang.String val)
val
- output format for resultspublic java.lang.String getOutFileBase()
public void setOutFileBase(java.lang.String outFileBase)
public java.lang.String getOutFileExtension()
public void setOutFileExtension(java.lang.String outFileExtension)
public java.lang.String getOutFile()
public java.io.PrintWriter getWriter() throws java.io.IOException
java.io.IOException
public void setWriter(java.io.PrintWriter writer)
public void printScriptBeginning(java.io.PrintWriter out) throws java.io.IOException
out
- java.io.IOException
public void endGmtAndCleanUp(java.io.PrintWriter out, java.lang.String psFile, java.lang.String projectionType)
public static boolean dashEquals(java.lang.String argName, java.lang.String arg)
protected abstract java.lang.String[] parseCmdLineArgs(java.lang.String[] origArgs) throws java.io.IOException
java.io.IOException
public abstract void init() throws TauPException
TauPException
public abstract void start() throws java.io.IOException, TauModelException, TauPException
java.io.IOException
TauModelException
TauPException
public abstract void destroy() throws TauPException
TauPException
public abstract void printUsage()
protected java.lang.String[] parseCommonCmdLineArgs(java.lang.String[] origArgs) throws java.io.IOException
java.io.IOException
public static java.lang.String toolNameFromClass(java.lang.Class toolClass)
public static void printStdUsageHead(java.lang.Class toolClass)
public static void printStdUsageTail()
public static void printNoComprendoArgs(java.lang.String[] noComprendoArgs)