Class TauP_Tool

    • Field Detail

      • outputFormat

        public java.lang.String outputFormat
      • outFileBase

        protected java.lang.String outFileBase
      • cmdLineArgs

        public java.lang.String[] cmdLineArgs
      • writer

        protected java.io.PrintWriter writer
      • toolProps

        protected java.util.Properties toolProps
    • Constructor Detail

      • TauP_Tool

        protected TauP_Tool()
    • 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 interface java.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()
      • configDefaults

        public static java.util.Properties configDefaults()
      • allowedOutputFormats

        public abstract java.lang.String[] allowedOutputFormats()
      • getOutputFormat

        public abstract java.lang.String getOutputFormat()
      • setDefaultOutputFormat

        public abstract void setDefaultOutputFormat()
      • 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
      • getOutFileBase

        public java.lang.String getOutFileBase()
      • setOutFileBase

        public void setOutFileBase​(java.lang.String outFileBase)
      • getOutFileExtension

        public java.lang.String getOutFileExtension()
      • setOutFileExtension

        public void setOutFileExtension​(java.lang.String outFileExtension)
      • setWriter

        public void setWriter​(java.io.PrintWriter writer)
      • printScriptBeginning

        public void printScriptBeginning​(java.io.PrintWriter out)
                                  throws java.io.IOException
        a noop that allows overriding classes to print things before results are calculated. For example to set up GMT commands before drawing paths.
        Parameters:
        out -
        Throws:
        java.io.IOException
      • endGmtAndCleanUp

        public void endGmtAndCleanUp​(java.io.PrintWriter out,
                                     java.lang.String psFile,
                                     java.lang.String projectionType)
      • dashEquals

        public static boolean dashEquals​(java.lang.String argName,
                                         java.lang.String arg)
      • parseOutputFormatCmdLineArgs

        protected java.lang.String[] parseOutputFormatCmdLineArgs​(java.lang.String[] origiArgs)
      • setToolPropsFilename

        public void setToolPropsFilename​(java.lang.String filename)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • toolNameFromClass

        public static java.lang.String toolNameFromClass​(java.lang.Class toolClass)
      • getStdUsageHead

        public static java.lang.String getStdUsageHead​(java.lang.Class toolClass)
      • getModDepthUsage

        public static java.lang.String getModDepthUsage()
      • getStdUsageTail

        public static java.lang.String getStdUsageTail()
      • printNoComprendoArgs

        public static void printNoComprendoArgs​(java.lang.String[] noComprendoArgs)