org.opensha.sha.earthquake.rupForecastImpl
Class SingleFaultRuptureERF

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

public class SingleFaultRuptureERF
extends AbstractERF

Title: SingleFaultRuptureERF

Description: This ERF has a single-source with a single, full-fault rupture. The following are the user-defined parameters:

The source is not Poissonian.

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

Field Summary
static String FAULT_PARAM_NAME
           
static String MAG_PARAM_NAME
           
static String NAME
           
static String PROB_PARAM_NAME
           
static String RAKE_PARAM_NAME
           
 
Fields inherited from class org.opensha.sha.earthquake.AbstractERF
adjustableParams, parameterChangeFlag, timeSpan, XML_METADATA_NAME
 
Constructor Summary
SingleFaultRuptureERF()
          Constructor for this source (no arguments)
SingleFaultRuptureERF(EqkRupture eqkRupture, double probability)
          Constructor for this source
 
Method Summary
 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.
 ArrayList getSourceList()
          This returns a list of sources (contains only one here)
 void setTimeSpan(TimeSpan time)
          This overides the parent method to ignore whatever is passed in (because timeSpan is always null in this class)
 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, 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 String NAME
See Also:
Constant Field Values

MAG_PARAM_NAME

public static final String MAG_PARAM_NAME
See Also:
Constant Field Values

PROB_PARAM_NAME

public static final String PROB_PARAM_NAME
See Also:
Constant Field Values

FAULT_PARAM_NAME

public static final String FAULT_PARAM_NAME
See Also:
Constant Field Values

RAKE_PARAM_NAME

public static final String RAKE_PARAM_NAME
See Also:
Constant Field Values
Constructor Detail

SingleFaultRuptureERF

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


SingleFaultRuptureERF

public SingleFaultRuptureERF(EqkRupture eqkRupture,
                             double probability)
Constructor for this source

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 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 String getName()
Return the name for this class

Returns:
: return the name for this class

setTimeSpan

public void setTimeSpan(TimeSpan time)
This overides the parent method to ignore whatever is passed in (because timeSpan is always null in this class)

Specified by:
setTimeSpan in interface BaseERF
Overrides:
setTimeSpan in class AbstractERF
Parameters:
timeSpan - : TimeSpan object