gov.usgs.earthquake.nshmp.calc

Class Site.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.calc.Site.Builder

Enclosing class:

Site

public static class Site.Builder
extends Object

A reusable Site builder. In the absence of specifying any site characteristics other than location (required), a default Site is returned by build(). Builder instances may be obtained via Site.builder().

See Also:

for default values

Method Summary

Modifier and Type	Method and Description
Site.Builder	basinDataProvider(URL url) Optional basin data provider.
Site	build() Build the Site.
Site.Builder	location(double lat, double lon) The location of the Site.
Site.Builder	location(Location loc) The location of the Site.
Site.Builder	location(NamedLocation namedLoc) The location of the Site; also sets the Site name.
Site.Builder	name(String name) The name of the Site.
Site.Builder	vs30(double vs30) The average shear-wave velocity down to 30 meters depth.
Site.Builder	vsInferred(boolean vsInferred) Whether Vs30 was inferred, true, or measured false.
Site.Builder	z1p0(double z1p0) Depth to the shear-wave velocity horizon of 1.0 km/s, in km.
Site.Builder	z2p5(double z2p5) Depth to the shear-wave velocity horizon of 2.5 km/s, in km.

Methods inherited from class java.lang.Object

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

Method Detail

name

public Site.Builder name(String name)

The name of the Site. Prior to setting, the supplied name is stripped of commas and truncated at 72 characters.

location

public Site.Builder location(Location loc)

The location of the Site.

location

public Site.Builder location(NamedLocation namedLoc)

The location of the Site; also sets the Site name.

location

public Site.Builder location(double lat,
                             double lon)

The location of the Site.

vs30

public Site.Builder vs30(double vs30)

The average shear-wave velocity down to 30 meters depth.

vsInferred

public Site.Builder vsInferred(boolean vsInferred)

Whether Vs30 was inferred, true, or measured false.

z1p0

public Site.Builder z1p0(double z1p0)

Depth to the shear-wave velocity horizon of 1.0 km/s, in km.

z2p5

public Site.Builder z2p5(double z2p5)

Depth to the shear-wave velocity horizon of 2.5 km/s, in km.

basinDataProvider

public Site.Builder basinDataProvider(URL url)

Optional basin data provider.

build

public Site build()

Build the Site.