org.opensha.sha.earthquake
Interface BaseERF

All Superinterfaces:

Comparable<BaseERF>, Named, Serializable

All Known Subinterfaces:

EpistemicListERF, ERF

All Known Implementing Classes:

AbstractEpistemicListERF, AbstractERF, AfterShockHypoMagFreqDistForecast, ClusterERF, CyberShakeERF, CyberShakeUCERFWrapper_ERF, FakeFrankel96, FaultERF, FloatingPoissonFaultERF, Frankel02_AdjustableEqkRupForecast, Frankel96_AdjustableEqkRupForecast, Frankel96_EqkRupForecast, GEM1_CEUS_ERF, GEM1_GlobalSS_ERF, GEM1_GSHAP_Africa_ERF, GEM1_GSHAP_SE_Asia_ERF, GEM1_NSHMP_SE_Asia_ERF, GEM1_US_ERF, GEM1_WEUS_ERF, GEM1ERF, GEM1ERF, GEM1SouthAmericaERF, GenericAfterHypoMagFreqDistForecast, GriddedHypoMagFreqDistForecast, GriddedHypoMagFreqDistForecastWrappedERF, GridERF, MeanUCERF2, MeanUCERF2_FM2pt1, MeanUCERF2_FM2pt2, NewZealandERF0909, NSHMP_ERF, NSHMP_ListERF, NSHMP08_CEUS_ERF, NSHMP2008, PEER_AreaForecast, PEER_LogicTreeERF_List, PEER_MultiSourceForecast, PEER_NonPlanarFaultForecast, Point2MultVertSS_FaultERF, Point2MultVertSS_FaultERF_List, PointPoissonSourceERF, PointSourceERF, PointToLineSourceERF, PoissonFaultERF, PuenteHillsFaultERF, SequenceAfterHypoMagFreqDistForecast, SingleFaultRuptureERF, SpatialAfterHypoMagFreqDistForecast, STEP_AftershockForecast, STEP_AlaskanPipeForecast, STEP_CombineForecastModels, STEP_EqkRupForecast, SubductionERF, TestGEM_ERF, TestSubductionZoneERF, UCERF2, UCERF2_TimeDependentEpistemicList, UCERF2_TimeIndependentEpistemicList, WG02_EqkRupForecast, WG02_ERF_Epistemic_List, WG02_FortranWrappedERF_EpistemicList, WGCEP_UCERF1_EqkRupForecast, WUS_ERF, YuccaMountainERF, YuccaMountainERF_List

public interface BaseERF
extends Named, Serializable, Comparable<BaseERF>

Title: ERF (was EqkRupForecastBaseAPI)

Description: This defines the common interface that applies to both an ERF and an EpistemicListERF (the methods that are common betwen the two).

Version:

1.0

Author:

: Ned Field, Nitin Gupta and Vipin Gupta

Field Summary

static String

NAME To increase load time for applications, the name of each ERF should be stored as a public static final String called "NAME".

Method Summary

ParameterList	getAdjustableParameterList() Gets the Adjustable parameter list for the ERF
Region	getApplicableRegion() Get the region for which this forecast is applicable
ArrayList<TectonicRegionType>	getIncludedTectonicRegionTypes() This specifies what types of Tectonic Regions are included in the ERF
TimeSpan	getTimeSpan() This method gets the time-span field
boolean	setParameter(String name, Object value) This will set the parameter with the given name to the given value.
void	setTimeSpan(TimeSpan time) This method sets the time-span field
String	updateAndSaveForecast() Update and save the serialized forecast into a file
void	updateForecast() This method tells the forecast that the user is done setting parameters and that it can now prepare itself for use.

Methods inherited from interface org.opensha.commons.data.Named

getName

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

NAME

static final String NAME

To increase load time for applications, the name of each ERF should be stored as a public static final String called "NAME". This is the default name, and should be overridden in implementing classes.

See Also:

Constant Field Values

Method Detail

updateForecast

void updateForecast()

This method tells the forecast that the user is done setting parameters and that it can now prepare itself for use. We could avoid needing this method if the forecast updated every time a parameter was changed, but this would be very inefficient with forecasts that take a lot of time to update. This also avoids problems associated with accidentally changing a parameter in the middle of a calculation.

updateAndSaveForecast

String updateAndSaveForecast()

Update and save the serialized forecast into a file

setTimeSpan

void setTimeSpan(TimeSpan time)

This method sets the time-span field

Parameters:

time -

getTimeSpan

TimeSpan getTimeSpan()

This method gets the time-span field

setParameter

boolean setParameter(String name,
                     Object value)

This will set the parameter with the given name to the given value.

Parameters:

name - String Name of the Adjustable Parameter

value - Object Parameter Value

Returns:

boolean boolean to see if it was successful in setting the parameter value.

getAdjustableParameterList

ParameterList getAdjustableParameterList()

Gets the Adjustable parameter list for the ERF

Returns:

getApplicableRegion

Region getApplicableRegion()

Get the region for which this forecast is applicable

Returns:

: Geographic region object specifying the applicable region of forecast

getIncludedTectonicRegionTypes

ArrayList<TectonicRegionType> getIncludedTectonicRegionTypes()

This specifies what types of Tectonic Regions are included in the ERF

Returns:

: ArrayList