gov.usgs.earthquake.nshmp.calc

Class EqRateExport

java.lang.Object

gov.usgs.earthquake.nshmp.calc.EqRateExport

public final class EqRateExport
extends Object

Earthquake rate and probability exporter.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
void	add(EqRate rate) Add an EqRate to this exporter.
void	addAll(Collection<EqRate> rates) Add the supplied EqRates to this exporter.
static EqRateExport	create(CalcConfig config, Sites sites, Logger log) Create a new results handler.
String	elapsedTime() A string representation of the time duration that this result handler has been running.
void	expire() Flushes any remaining results, stops all timers and sets the state of this exporter to 'used'; no more results may be added.
Path	outputDir() The target output directory established by this handler.
int	resultsProcessed() The number of hazard [and deagg] results passed to this handler thus far.
int	size() The number of Hazard results this handler is currently storing.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EqRateExport create(CalcConfig config,
                                  Sites sites,
                                  Logger log)
                           throws IOException

Create a new results handler.

Parameters:

config - that specifies output options and formats

sites - reference to the sites to be processed (not retained)

log - shared logging instance from calling class

Throws:

IllegalStateException - if binary output has been specified in the config but the sites container does not specify map extents.

IOException

addAll

public void addAll(Collection<EqRate> rates)
            throws IOException

Add the supplied EqRates to this exporter.

Parameters:

rates - data containers to add

Throws:

IOException

add

public void add(EqRate rate)
         throws IOException

Add an EqRate to this exporter.

Parameters:

rate - data container to add

Throws:

IOException

expire

public void expire()
            throws IOException

Flushes any remaining results, stops all timers and sets the state of this exporter to 'used'; no more results may be added.

Throws:

IOException

resultsProcessed

public int resultsProcessed()

The number of hazard [and deagg] results passed to this handler thus far.

size

public int size()

The number of Hazard results this handler is currently storing.

elapsedTime

public String elapsedTime()

A string representation of the time duration that this result handler has been running.

outputDir

public Path outputDir()

The target output directory established by this handler.