org.opensha.sha.earthquake.rupForecastImpl
Class PointPoissonSourceERF

java.lang.Object
  extended by org.opensha.sha.earthquake.AbstractERF
      extended by org.opensha.sha.earthquake.rupForecastImpl.PointPoissonSourceERF
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BaseERF>, java.lang.Iterable<ProbEqkSource>, java.util.EventListener, Named, XMLSaveable, ParameterChangeListener, TimeSpanChangeListener, BaseERF, ERF

public class PointPoissonSourceERF
extends AbstractERF

Title: PointPoissonSourceERF

Description: This ERF creates a single PointEqkSource for the following user-defined parameters:

The source is Poissonain, and the timeSpan is in years.

Version:
1.0
Author:
Ned Field Date : June , 2004
See Also:
Serialized Form

Field Summary
static java.lang.String DIP_PARAM_NAME
           
static java.lang.String MAG_DIST_PARAM_NAME
           
static java.lang.String NAME
           
static java.lang.String RAKE_PARAM_NAME
           
static java.lang.String SRC_DEPTH_PARAM_NAME
           
static java.lang.String SRC_LAT_PARAM_NAME
           
static java.lang.String SRC_LON_PARAM_NAME
           
 
Fields inherited from class org.opensha.sha.earthquake.AbstractERF
adjustableParams, nthRupIndicesForSource, parameterChangeFlag, rupIndexForNthRup, srcIndexForNthRup, timeSpan, totNumRups, XML_METADATA_NAME
 
Constructor Summary
PointPoissonSourceERF()
          Constructor for this source (no arguments)
 
Method Summary
 java.lang.String getName()
          Return the name for this class
 int getNumSources()
          Returns the number of earthquake sources (always "1" here)
 ProbEqkSource getSource(int iSource)
          Return the earhthquake source at index i.
 java.util.ArrayList getSourceList()
          This returns a list of sources (contains only one here)
 void updateForecast()
          update the source based on the paramters (only if a parameter value has changed)
 
Methods inherited from class org.opensha.sha.earthquake.AbstractERF
baseERF_FromXML, baseERF_ToXML, compareTo, drawRandomEventSet, fromXMLMetadata, getAdjustableParameterList, getApplicableRegion, getIncludedTectonicRegionTypes, getNumRuptures, getParameter, getRupture, getRuptureClone, getSourceClone, getTimeSpan, iterator, parameterChange, setParameter, setParameter, setParameterChangeFlag, setTimeSpan, timeSpanChange, toXMLMetadata, updateAndSaveForecast
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values

MAG_DIST_PARAM_NAME

public static final java.lang.String MAG_DIST_PARAM_NAME
See Also:
Constant Field Values

RAKE_PARAM_NAME

public static final java.lang.String RAKE_PARAM_NAME
See Also:
Constant Field Values

DIP_PARAM_NAME

public static final java.lang.String DIP_PARAM_NAME
See Also:
Constant Field Values

SRC_LAT_PARAM_NAME

public static final java.lang.String SRC_LAT_PARAM_NAME
See Also:
Constant Field Values

SRC_LON_PARAM_NAME

public static final java.lang.String SRC_LON_PARAM_NAME
See Also:
Constant Field Values

SRC_DEPTH_PARAM_NAME

public static final java.lang.String SRC_DEPTH_PARAM_NAME
See Also:
Constant Field Values
Constructor Detail

PointPoissonSourceERF

public PointPoissonSourceERF()
Constructor for this source (no arguments)

Method Detail

updateForecast

public void updateForecast()
update the source based on the paramters (only if a parameter value has changed)


getSource

public ProbEqkSource getSource(int iSource)
Return the earhthquake source at index i. Note that this returns a pointer to the source held internally, so that if any parameters are changed, and this method is called again, the source obtained by any previous call to this method will no longer be valid.

Parameters:
iSource - : index of the desired source (only "0" allowed here).
Returns:
Returns the ProbEqkSource at index i

getNumSources

public int getNumSources()
Returns the number of earthquake sources (always "1" here)

Returns:
integer value specifying the number of earthquake sources

getSourceList

public java.util.ArrayList getSourceList()
This returns a list of sources (contains only one here)

Specified by:
getSourceList in interface ERF
Overrides:
getSourceList in class AbstractERF
Returns:
ArrayList of Prob Earthquake sources

getName

public java.lang.String getName()
Return the name for this class

Returns:
: return the name for this class