org.opensha.sha.calc.hazardMap.components
Class AsciiFileCurveArchiver

java.lang.Object
  org.opensha.sha.calc.hazardMap.components.AsciiFileCurveArchiver

All Implemented Interfaces:

XMLSaveable, CurveResultsArchiver

public class AsciiFileCurveArchiver
extends Object
implements CurveResultsArchiver

This class writes hazard curves to simple output files.

Author:

kevin

Field Summary

static String

XML_METADATA_NAME

Constructor Summary

AsciiFileCurveArchiver(String outputDir, boolean binByLat, boolean binByLon)

Method Summary

void	archiveCurve(ArbitrarilyDiscretizedFunc curve, CurveMetadata meta) This stores the curve for the given site.
static AsciiFileCurveArchiver	fromXMLMetadata(Element archiverEl)
String	getOutputDir()
File	getStoreDir() Return the store dir if applicable (null otherwise) for this archiver.
boolean	isCurveCalculated(CurveMetadata meta, ArbitrarilyDiscretizedFunc xVals) Returns true if the given curve has already been calculated and archived
void	setOutputDir(String outputDir)
Element	toXMLMetadata(Element root)

Methods inherited from class java.lang.Object

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

Field Detail

XML_METADATA_NAME

public static final String XML_METADATA_NAME

See Also:

Constant Field Values

Constructor Detail

AsciiFileCurveArchiver

public AsciiFileCurveArchiver(String outputDir,
                              boolean binByLat,
                              boolean binByLon)
                       throws IOException

Parameters:

outputDir - - directory where curves will be stored

binByLat - - if true, curves will be put in subdirectories for each latitude value. This prevents directories from getting too large (storing too many files) for big calculatoins

binByLon - - same as binByLat but for longitude

Throws:

IOException

Method Detail

archiveCurve

public void archiveCurve(ArbitrarilyDiscretizedFunc curve,
                         CurveMetadata meta)
                  throws IOException

Description copied from interface: CurveResultsArchiver

This stores the curve for the given site.

Specified by:

archiveCurve in interface CurveResultsArchiver

Parameters:

curve - - the curve itself

meta - - curve metadata

Throws:

IOException

getOutputDir

public String getOutputDir()

setOutputDir

public void setOutputDir(String outputDir)
                  throws IOException

Throws:

IOException

toXMLMetadata

public Element toXMLMetadata(Element root)

Specified by:

toXMLMetadata in interface XMLSaveable

fromXMLMetadata

public static AsciiFileCurveArchiver fromXMLMetadata(Element archiverEl)
                                              throws IOException

Throws:

IOException

isCurveCalculated

public boolean isCurveCalculated(CurveMetadata meta,
                                 ArbitrarilyDiscretizedFunc xVals)

Description copied from interface: CurveResultsArchiver

Returns true if the given curve has already been calculated and archived

Specified by:

isCurveCalculated in interface CurveResultsArchiver

Returns:

getStoreDir

public File getStoreDir()

Description copied from interface: CurveResultsArchiver

Return the store dir if applicable (null otherwise) for this archiver.

Specified by:

getStoreDir in interface CurveResultsArchiver

Returns: