org.opensha.sha.earthquake
Interface EpistemicListERF

All Superinterfaces:
BaseERF, java.lang.Comparable<BaseERF>, Named, java.io.Serializable
All Known Implementing Classes:
AbstractEpistemicListERF, NSHMP_ListERF, NSHMP2008, PEER_LogicTreeERF_List, Point2MultVertSS_FaultERF_List, UCERF2_TimeDependentEpistemicList, UCERF2_TimeIndependentEpistemicList, WG02_ERF_Epistemic_List, WG02_FortranWrappedERF_EpistemicList, WUS_ERF, YuccaMountainERF_List

public interface EpistemicListERF
extends BaseERF

Title: EpistemicListERF (was ERF_ListAPI)

Description: This represents an epistemic list of earthquake rupture forecasts and their associated weights.

Version:
1.0
Author:
: Ned Field, Nitin Gupta and Vipin Gupta

Field Summary
 
Fields inherited from interface org.opensha.sha.earthquake.BaseERF
NAME
 
Method Summary
 double getERF_RelativeWeight(int index)
          get the weight of the ERF at the specified index
 ERF getERF(int index)
          get the ERF in the list with the specified index
 int getNumERFs()
          get the number of Eqk Rup Forecasts in this list
 java.util.ArrayList<java.lang.Double> getRelativeWeightsList()
          Return the vector containing the Double values with relative weights for each ERF
 
Methods inherited from interface org.opensha.sha.earthquake.BaseERF
getAdjustableParameterList, getApplicableRegion, getIncludedTectonicRegionTypes, getTimeSpan, setParameter, setTimeSpan, updateAndSaveForecast, updateForecast
 
Methods inherited from interface org.opensha.commons.data.Named
getName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getERF

ERF getERF(int index)
get the ERF in the list with the specified index

Parameters:
index - : index of Eqk Rup forecast to return
Returns:

getERF_RelativeWeight

double getERF_RelativeWeight(int index)
get the weight of the ERF at the specified index

Parameters:
index - : index of ERF
Returns:
: relative weight of ERF

getRelativeWeightsList

java.util.ArrayList<java.lang.Double> getRelativeWeightsList()
Return the vector containing the Double values with relative weights for each ERF

Returns:
: ArrayList of Double values

getNumERFs

int getNumERFs()
get the number of Eqk Rup Forecasts in this list

Returns:
: number of eqk rup forecasts in this list