Package edu.sc.seis.TauP.cmdline.args

Class PhaseArgs

java.lang.Object

edu.sc.seis.TauP.cmdline.args.PhaseArgs

public class PhaseArgs
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PHASES

Constructor Summary

Constructors

Constructor	Description
PhaseArgs()

Method Summary

Modifier and Type	Method	Description
static List<String>	extractPhaseNames(String phaseNames)	Parse comma separated list of phase names, expanding convience phase names like ttp into real phase names.
static String	getPhaseNamesAsString(List<PhaseName> phaseNameList)
boolean	isEmpty()
List<PhaseName>	parsePhaseNameList()
protected List<String>	readPhaseFile(String filename)	Reads in list of phase names from a text file.
void	setPhaseFiles(List<String> phaseFile)
void	setPhaseNames(List<String> phaseNamesStr)	names of phases to be used, ie P,S,PKIKP.
void	setTool(TauP_AbstractPhaseTool tool)
static String[]	splitPhaseNameList(String phaseList)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PHASES

public static final String DEFAULT_PHASES

See Also:

• Constant Field Values

Constructor Details

PhaseArgs

public PhaseArgs()

Method Details

extractPhaseNames

public static List<String> extractPhaseNames(String phaseNames)

Parse comma separated list of phase names, expanding convience phase names like ttp into real phase names.

Parameters:

phaseNames - string to parse

Returns:

parsed list of phase names

splitPhaseNameList

public static String[] splitPhaseNameList(String phaseList)

setTool

public void setTool(TauP_AbstractPhaseTool tool)

setPhaseNames

public void setPhaseNames(List<String> phaseNamesStr)

names of phases to be used, ie P,S,PKIKP.

Parameters:

phaseNamesStr - phases to calculate

setPhaseFiles

public void setPhaseFiles(List<String> phaseFile)

parsePhaseNameList

public List<PhaseName> parsePhaseNameList()
                                   throws PhaseParseException

Throws:

PhaseParseException

getPhaseNamesAsString

public static String getPhaseNamesAsString(List<PhaseName> phaseNameList)

readPhaseFile

protected List<String> readPhaseFile(String filename)
                              throws IOException

Reads in list of phase names from a text file. So long as each phase name is separated by some whitespace, " " or newline or tab, it should read them fine. Also, comments are allowed, either # or // are comments to the end of the line while c style slash-star make a block a comment.

Parameters:

filename - file to read

Returns:

list of phase names from file

Throws:

IOException - if problem reading file

isEmpty

public boolean isEmpty()