gov.usgs.earthquake.nshmp.calc

Enum DataType

java.lang.Object

java.lang.Enum<DataType>

gov.usgs.earthquake.nshmp.calc.DataType

All Implemented Interfaces:

Serializable, Comparable<DataType>

public enum DataType
extends Enum<DataType>

Data type identifiers. These are used to specify the different types of hazard curves or other data that should be saved after a calculation is complete.

Author:

Peter Powers

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Binary hazard curves.
GMM Ground motion model specific data.
SOURCE Data by SourceType.
TOTAL Total hazard curves or magnitude-frequency distributions, etc.

Method Summary

Modifier and Type	Method and Description
static DataType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOTAL

public static final DataType TOTAL

Total hazard curves or magnitude-frequency distributions, etc.

GMM

public static final DataType GMM

Ground motion model specific data.

SOURCE

public static final DataType SOURCE

Data by SourceType.

BINARY

public static final DataType BINARY

Binary hazard curves. Binary curves may only be saved for map calculations for which a map 'extents' region has been defined. See the site specification page for more details.

The output format is a NSHMP file format that works with a number of legacy fortran codes still in use. See nshmp-haz-fortran. Users should be aware that the format has certain restrictions, for instance, the maximum number of intensity measure levels that can be accomodated is 20. Buyer beware.

Method Detail

values

public static DataType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataType c : DataType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null