Class TauP_Tool

    • Field Detail

      • DEBUG

        public static boolean DEBUG
        Turns on debugging output.
      • verbose

        public boolean verbose
        Turns on verbose output.
      • outputFormat

        public java.lang.String outputFormat
      • outFileBase

        protected java.lang.String outFileBase
      • expert

        public static boolean expert
        Turns on expert mode.
      • writer

        protected java.io.PrintWriter writer
      • toolProps

        protected java.util.Properties toolProps
      • outForms

        protected Outputs outForms
    • Constructor Detail

      • TauP_Tool

        protected TauP_Tool()
    • Method Detail

      • getOutputFormat

        public java.lang.String getOutputFormat()
      • setOutputFormat

        public void setOutputFormat​(java.lang.String val)
        usually one of TauP_Time.TEXT or TauP_Time.JSON. Subclasses may add additional types, for example TauP_Path.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)
      • getOutFile

        public java.lang.String getOutFile()
      • getWriter

        public java.io.PrintWriter getWriter()
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • 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)
      • parseCmdLineArgs

        protected abstract java.lang.String[] parseCmdLineArgs​(java.lang.String[] origArgs)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • printUsage

        public abstract void printUsage()
      • parseCommonCmdLineArgs

        protected java.lang.String[] parseCommonCmdLineArgs​(java.lang.String[] origArgs)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • toolNameFromClass

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

        public static void printStdUsageHead​(java.lang.Class toolClass)
      • printStdUsageTail

        public static void printStdUsageTail()
      • printNoComprendoArgs

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