gov.usgs.earthquake.nshmp.mfd

Enum MfdType

java.lang.Object

java.lang.Enum<MfdType>

gov.usgs.earthquake.nshmp.mfd.MfdType

All Implemented Interfaces:

Serializable, Comparable<MfdType>

public enum MfdType
extends Enum<MfdType>

Magnitude-frequency distribution (MFD) type identifier.

Author:

Peter Powers

See Also:

Mfds

Enum Constant Summary

Enum Constants

Enum Constant and Description
GR An incremental Gutenberg-Richter MFD.
GR_TAPER A Gutenberg-Richter MFD with a tapered upper tail.
INCR An MFD defining multiple magnitudes with varying rates.
SINGLE An MFD with a single magnitude and rate.

Method Summary

Modifier and Type	Method and Description
static MfdType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MfdType[]	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

SINGLE

public static final MfdType SINGLE

An MFD with a single magnitude and rate.

GR

public static final MfdType GR

An incremental Gutenberg-Richter MFD.

GR_TAPER

public static final MfdType GR_TAPER

A Gutenberg-Richter MFD with a tapered upper tail.

INCR

public static final MfdType INCR

An MFD defining multiple magnitudes with varying rates. This is only used in the 2008 California model where the rates of magnitudes above 6.5 were reduced by a fixed amount, yielding MFDs that no longer had a clean functional form.

Method Detail

values

public static MfdType[] 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 (MfdType c : MfdType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MfdType 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