org.opensha.sha.earthquake.rupForecastImpl.PEER_TestCases
Class PEER_AreaForecast

java.lang.Object
  org.opensha.sha.earthquake.AbstractERF
      org.opensha.sha.earthquake.rupForecastImpl.PEER_TestCases.PEER_AreaForecast

All Implemented Interfaces:

Serializable, Comparable<BaseERF>, Iterable<ProbEqkSource>, EventListener, Named, XMLSaveable, ParameterChangeListener, TimeSpanChangeListener, BaseERF, ERF

public class PEER_AreaForecast
extends AbstractERF

Title: PEER_AreaForecast

Description: PEER's Area earthquake-rupture forecast. The Peer Group Test cases

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Author:

Nitin Gupta & Vipin Gupta Date : Oct 24, 2002

See Also:

Serialized Form

Field Summary

static String	DEPTH_LOWER_PARAM_NAME
static String	DEPTH_PARAM_UNITS
static String	DEPTH_UPPER_PARAM_NAME
static String	DIP_PARAM_NAME
static String	DIP_PARAM_UNITS
static String	GRID_PARAM_NAME
static String	GRID_PARAM_UNITS
static String	MAG_DIST_PARAM_NAME
static String	NAME
static String	RAKE_PARAM_NAME
static String	RAKE_PARAM_UNITS

Fields inherited from class org.opensha.sha.earthquake.AbstractERF

adjustableParams, parameterChangeFlag, timeSpan, XML_METADATA_NAME

Constructor Summary

PEER_AreaForecast()
This constructor constructs the source No argument constructor

Method Summary

String	getName() Return the name for this class
int	getNumSources() Get the number of earthquake sources
ProbEqkSource	getSource(int iSource) Return the earhthquake source at index i.
ArrayList	getSourceList() Not yet implemented
void	updateForecast() update the sources based on the user paramters, only when user has changed a parameter

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, 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 String NAME

See Also:

Constant Field Values

GRID_PARAM_NAME

public static final String GRID_PARAM_NAME

See Also:

Constant Field Values

GRID_PARAM_UNITS

public static final String GRID_PARAM_UNITS

See Also:

Constant Field Values

DEPTH_LOWER_PARAM_NAME

public static final String DEPTH_LOWER_PARAM_NAME

See Also:

Constant Field Values

DEPTH_UPPER_PARAM_NAME

public static final String DEPTH_UPPER_PARAM_NAME

See Also:

Constant Field Values

DEPTH_PARAM_UNITS

public static final String DEPTH_PARAM_UNITS

See Also:

Constant Field Values

MAG_DIST_PARAM_NAME

public static final String MAG_DIST_PARAM_NAME

See Also:

Constant Field Values

RAKE_PARAM_NAME

public static final String RAKE_PARAM_NAME

See Also:

Constant Field Values

RAKE_PARAM_UNITS

public static final String RAKE_PARAM_UNITS

See Also:

Constant Field Values

DIP_PARAM_NAME

public static final String DIP_PARAM_NAME

See Also:

Constant Field Values

DIP_PARAM_UNITS

public static final String DIP_PARAM_UNITS

See Also:

Constant Field Values

Constructor Detail

PEER_AreaForecast

public PEER_AreaForecast()

This constructor constructs the source No argument constructor

Method Detail

updateForecast

public void updateForecast()

update the sources based on the user paramters, only when user has changed a parameter

getSource

public ProbEqkSource getSource(int iSource)

Return the earhthquake source at index i. This methos returns the reference to the class variable. So, when you call this method again, result from previous method call may no longer bevalid. this is secret, fast but dangerous method

Parameters:

iSource - : index of the source needed

Returns:

Returns the ProbEqkSource at index i

getNumSources

public int getNumSources()

Get the number of earthquake sources

Returns:

integer value specifying the number of earthquake sources

getSourceList

public ArrayList getSourceList()

Not yet implemented

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