org.opensha.sha.earthquake
Enum ERF_Ref

java.lang.Object
  extended by java.lang.Enum<ERF_Ref>
      extended by org.opensha.sha.earthquake.ERF_Ref
All Implemented Interfaces:
Serializable, Comparable<ERF_Ref>

public enum ERF_Ref
extends Enum<ERF_Ref>


Enum Constant Summary
CYBERSHAKE_UCERF2_WRAPPER
          CyberShake ERF that wraps UCERF2 for use with the CyberShake Fake IMR
FRANKEL_02
          Frankel/USGS 2002 Adjustable ERF
FRANKEL_96
          Frankel/USGS 1996 ERF
FRANKEL_ADJUSTABLE_96
          Frankel/USGS 1996 Adjustable ERF
GEM1_CEUS
          GEM1 Central/Eastern United States ERF
GEM1_GSHAP_AFRICA
          GEM1 GSHAP Africa ERF
GEM1_GSHAP_WE_ASIA
          GEM1 GSHAP South/East Asia ERF
GEM1_NSHMP_WE_ASIA
          GEM1 NSHMP South/East Asia ERF
GEM1_SOUTH_AMERICA
          GEM1 South America ERF
GEM1_WEUS
          GEM1 Western United States ERF
INVERSION_SOLUTION_ERF
           
MEAN_UCERF_2
          WGCEP Mean UCERF 2
MEAN_UCERF_2_Mod
          WGCEP Mean UCERF 2
MEAN_UCERF3
           
NEW_ZEALAND_2012
           
NSHMP_CEUS_08
          NSHMP CEUS 2008 ERF
PEER_AREA
          PEER Area Forecast
PEER_LOGIC_TREE
          PEER Logic Tree Forecast
PEER_MULTI_SOURCE
          PEER Multi Source Forecast
PEER_NON_PLANAR_FAULT
          PEER Non Planar Fault Forecast
POINT_SOURCE
          Point Source ERF
POINT_SOURCE_MULTI_VERT
          Point Source Multi Vert ERF
POINT_SOURCE_MULTI_VERT_LIST
          Point Source Multi Vert ERF
POISSON_FAULT
          Poisson Fault ERF
POISSON_FLOATING_FAULT
          Floating Poisson Fault ERF
STEP_ALASKA
          STEP Alaska Forecast
UCERF_2
          WGCEP UCERF 2 ERF
UCERF_2_TIME_INDEP_LIST
          WGCEP UCERF 2 Time Independent Epistemic List
UCERF3_COMPOUND
           
URS_MEAN_UCERF_2
          URS modified MeanUCERF2
WGCEP_02
          WGCEP 2002 ERF
WGCEP_02_LIST
          WGCEP 2002 ERF Epistemic List
WGCEP_02_WRAPPED_LIST
          WGCEP 2002 Fortran Wrapped ERF
WGCEP_UCERF_1
          WGCEP UCERF 1
YUCCA_MOUNTAIN
          Yucca Mountain ERF
YUCCA_MOUNTAIN_LIST
          Yucca Mountain ERF List
 
Method Summary
static Set<ERF_Ref> get(boolean includeListERFs)
          Convenience method to return references for all EqkRupForecastBaseAPI implementations that are currently production quality (i.e.
static Set<ERF_Ref> get(boolean includeListERFs, DevStatus... stati)
          Convenience method to return references to EqkRupForecastBaseAPI implementations at the specified levels of development.
static Set<ERF_Ref> get(boolean includeListERFs, ServerPrefs prefs)
          Convenience method to return references for all EqkRupForecastBaseAPI implementations that should be included in applications with the given ServerPrefs.
 Class<? extends BaseERF> getERFClass()
           
 BaseERF instance()
          Returns a new instance of the ERF represented by this reference.
 boolean isERFList()
           
 DevStatus status()
          Returns the development status of the referenced EqkRupForecastBaseAPI.
 String toString()
           
static ERF_Ref valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ERF_Ref[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FRANKEL_ADJUSTABLE_96

public static final ERF_Ref FRANKEL_ADJUSTABLE_96
Frankel/USGS 1996 Adjustable ERF


FRANKEL_96

public static final ERF_Ref FRANKEL_96
Frankel/USGS 1996 ERF


FRANKEL_02

public static final ERF_Ref FRANKEL_02
Frankel/USGS 2002 Adjustable ERF


WGCEP_02

public static final ERF_Ref WGCEP_02
WGCEP 2002 ERF


WGCEP_02_LIST

public static final ERF_Ref WGCEP_02_LIST
WGCEP 2002 ERF Epistemic List


WGCEP_02_WRAPPED_LIST

public static final ERF_Ref WGCEP_02_WRAPPED_LIST
WGCEP 2002 Fortran Wrapped ERF


WGCEP_UCERF_1

public static final ERF_Ref WGCEP_UCERF_1
WGCEP UCERF 1


PEER_AREA

public static final ERF_Ref PEER_AREA
PEER Area Forecast


PEER_NON_PLANAR_FAULT

public static final ERF_Ref PEER_NON_PLANAR_FAULT
PEER Non Planar Fault Forecast


PEER_MULTI_SOURCE

public static final ERF_Ref PEER_MULTI_SOURCE
PEER Multi Source Forecast


PEER_LOGIC_TREE

public static final ERF_Ref PEER_LOGIC_TREE
PEER Logic Tree Forecast


POISSON_FLOATING_FAULT

public static final ERF_Ref POISSON_FLOATING_FAULT
Floating Poisson Fault ERF


POISSON_FAULT

public static final ERF_Ref POISSON_FAULT
Poisson Fault ERF


POINT_SOURCE

public static final ERF_Ref POINT_SOURCE
Point Source ERF


POINT_SOURCE_MULTI_VERT

public static final ERF_Ref POINT_SOURCE_MULTI_VERT
Point Source Multi Vert ERF


POINT_SOURCE_MULTI_VERT_LIST

public static final ERF_Ref POINT_SOURCE_MULTI_VERT_LIST
Point Source Multi Vert ERF


UCERF_2

public static final ERF_Ref UCERF_2
WGCEP UCERF 2 ERF


UCERF_2_TIME_INDEP_LIST

public static final ERF_Ref UCERF_2_TIME_INDEP_LIST
WGCEP UCERF 2 Time Independent Epistemic List


MEAN_UCERF_2

public static final ERF_Ref MEAN_UCERF_2
WGCEP Mean UCERF 2


MEAN_UCERF_2_Mod

public static final ERF_Ref MEAN_UCERF_2_Mod
WGCEP Mean UCERF 2


YUCCA_MOUNTAIN

public static final ERF_Ref YUCCA_MOUNTAIN
Yucca Mountain ERF


YUCCA_MOUNTAIN_LIST

public static final ERF_Ref YUCCA_MOUNTAIN_LIST
Yucca Mountain ERF List


NSHMP_CEUS_08

public static final ERF_Ref NSHMP_CEUS_08
NSHMP CEUS 2008 ERF


GEM1_SOUTH_AMERICA

public static final ERF_Ref GEM1_SOUTH_AMERICA
GEM1 South America ERF


GEM1_CEUS

public static final ERF_Ref GEM1_CEUS
GEM1 Central/Eastern United States ERF


GEM1_WEUS

public static final ERF_Ref GEM1_WEUS
GEM1 Western United States ERF


GEM1_GSHAP_AFRICA

public static final ERF_Ref GEM1_GSHAP_AFRICA
GEM1 GSHAP Africa ERF


GEM1_GSHAP_WE_ASIA

public static final ERF_Ref GEM1_GSHAP_WE_ASIA
GEM1 GSHAP South/East Asia ERF


GEM1_NSHMP_WE_ASIA

public static final ERF_Ref GEM1_NSHMP_WE_ASIA
GEM1 NSHMP South/East Asia ERF


STEP_ALASKA

public static final ERF_Ref STEP_ALASKA
STEP Alaska Forecast


NEW_ZEALAND_2012

public static final ERF_Ref NEW_ZEALAND_2012

URS_MEAN_UCERF_2

public static final ERF_Ref URS_MEAN_UCERF_2
URS modified MeanUCERF2


CYBERSHAKE_UCERF2_WRAPPER

public static final ERF_Ref CYBERSHAKE_UCERF2_WRAPPER
CyberShake ERF that wraps UCERF2 for use with the CyberShake Fake IMR


INVERSION_SOLUTION_ERF

public static final ERF_Ref INVERSION_SOLUTION_ERF

MEAN_UCERF3

public static final ERF_Ref MEAN_UCERF3

UCERF3_COMPOUND

public static final ERF_Ref UCERF3_COMPOUND
Method Detail

values

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

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

valueOf

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

toString

public String toString()
Overrides:
toString in class Enum<ERF_Ref>

status

public DevStatus status()
Returns the development status of the referenced EqkRupForecastBaseAPI.

Returns:
the development status

isERFList

public boolean isERFList()
Returns:
true if this is an ERF Epistemic List, false otherwise

instance

public BaseERF instance()
Returns a new instance of the ERF represented by this reference.

Returns:
a new EqkRupForecastBaseAPI instance

getERFClass

public Class<? extends BaseERF> getERFClass()

get

public static Set<ERF_Ref> get(boolean includeListERFs)
Convenience method to return references for all EqkRupForecastBaseAPI implementations that are currently production quality (i.e. fully tested and documented), under development, or experimental. The Set of references returned does not include deprecated references.

Parameters:
includeListERFs - if true, Epistemic List ERFs will be included, otherwise they will be excluded
Returns:
reference Set of all non-deprecated EqkRupForecastBaseAPIs
See Also:
DevStatus

get

public static Set<ERF_Ref> get(boolean includeListERFs,
                               ServerPrefs prefs)
Convenience method to return references for all EqkRupForecastBaseAPI implementations that should be included in applications with the given ServerPrefs. Production applications only include production IMRs, and development applications include everything but deprecated IMRs.

Parameters:
includeListERFs - if true, Epistemic List ERFs will be included, otherwise they will be excluded
prefs - ServerPrefs instance for which IMRs should be selected
Returns:

get

public static Set<ERF_Ref> get(boolean includeListERFs,
                               DevStatus... stati)
Convenience method to return references to EqkRupForecastBaseAPI implementations at the specified levels of development.

Parameters:
includeListERFs - if true, Epistemic List ERFs will be included, otherwise they will be excluded
stati - the development level(s) of the EqkRupForecastBaseAPI references to be retrieved
Returns:
a Set of EqkRupForecastBaseAPI references
See Also:
DevStatus