gov.usgs.earthquake.nshmp.calc

Class CalcConfig.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.calc.CalcConfig.Builder

Enclosing class:

CalcConfig

public static final class CalcConfig.Builder
extends Object

A builder of configuration instances.

Method Summary

Modifier and Type	Method and Description
CalcConfig	build() Build a new calculation configuration.
static CalcConfig.Builder	copyOf(CalcConfig config) Initialize a new builder with values copied from the supplied config.
CalcConfig.Builder	distance(double distance) Set the cutoff distance within which to include all sources when computing earthquake rates or probabilities.
CalcConfig.Builder	extend(CalcConfig.Builder that) Extend this builder to match that builder.
static CalcConfig.Builder	fromFile(Path path) Create a new builder from the resource at the specified path.
CalcConfig.Builder	imts(Set<Imt> imts) Set the IMTs for which results should be calculated.
CalcConfig.Builder	timespan(double timespan) Set the timespan for earthquake probabilities.
static CalcConfig.Builder	withDefaults() Initialize a new builder with all fields initialized to default values.

Methods inherited from class java.lang.Object

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

Method Detail

copyOf

public static CalcConfig.Builder copyOf(CalcConfig config)

Initialize a new builder with values copied from the supplied config.

fromFile

public static CalcConfig.Builder fromFile(Path path)
                                   throws IOException

Create a new builder from the resource at the specified path. This will only set those fields that are explicitely defined.

Parameters:

path - to configuration file or resource

Throws:

IOException

withDefaults

public static CalcConfig.Builder withDefaults()

Initialize a new builder with all fields initialized to default values.

extend

public CalcConfig.Builder extend(CalcConfig.Builder that)

Extend this builder to match that builder. Fields in that builder take precedence unless they are not set.

imts

public CalcConfig.Builder imts(Set<Imt> imts)

Set the IMTs for which results should be calculated.

See Also:

CalcConfig.Hazard.imts

timespan

public CalcConfig.Builder timespan(double timespan)

Set the timespan for earthquake probabilities. Calling this method also sets CalcConfig.Rate.valueFormat to ValueFormat.POISSON_PROBABILITY to ensure consistency.

See Also:

CalcConfig.Rate.timespan

distance

public CalcConfig.Builder distance(double distance)

Set the cutoff distance within which to include all sources when computing earthquake rates or probabilities.

See Also:

CalcConfig.Rate.distance

build

public CalcConfig build()

Build a new calculation configuration.