org.opensha.sha.earthquake.griddedForecast
Class GriddedHypoMagFreqDistForecastWrappedERF

java.lang.Object
  org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast
      org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecastWrappedERF

All Implemented Interfaces:

Serializable, Comparable<BaseERF>, EventListener, Named, ParameterChangeListener, BaseERF, HypoMagFreqDistAtMultLocsAPI

public class GriddedHypoMagFreqDistForecastWrappedERF
extends GriddedHypoMagFreqDistForecast

Title: GriddedHypoMagFreqDistForecastWrappedERF

Description: This class wraps any Earthquake Rupture Forecast into a GriddedHypoMagFreqDistForecast.

Since:

Sept 16, 2005

Version:

1.0

Author:

Nitin Gupta

See Also:

Serialized Form

Field Summary

Fields inherited from class org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast

parameterChangeFlag, region

Fields inherited from interface org.opensha.sha.earthquake.BaseERF

NAME

Constructor Summary

GriddedHypoMagFreqDistForecastWrappedERF(ERF eqkRupForecast)
Class constructor that accepts the EqkRupForecast as the argument.

Method Summary

HypoMagFreqDistAtLoc	getHypoMagFreqDistAtLoc(int ithLocation) gets the Hypocenter Mag.
void	updateForecast() If any parameter has been changed then update the forecast.

Methods inherited from class org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast

compareTo, getAdjustableParameterList, getAdjustableParamsIterator, getApplicableRegion, getIncludedTectonicRegionTypes, getName, getNumHypoLocs, getRegion, getTimeSpan, parameterChange, setParameter, setRegion, setTimeSpan, timeSpanChange, updateAndSaveForecast

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GriddedHypoMagFreqDistForecastWrappedERF

public GriddedHypoMagFreqDistForecastWrappedERF(ERF eqkRupForecast)

Class constructor that accepts the EqkRupForecast as the argument.

Parameters:

eqkRupforecast - EqkRupForecastAPI

Method Detail

updateForecast

public void updateForecast()

If any parameter has been changed then update the forecast.

Specified by:

updateForecast in interface BaseERF

Overrides:

updateForecast in class GriddedHypoMagFreqDistForecast

getHypoMagFreqDistAtLoc

public HypoMagFreqDistAtLoc getHypoMagFreqDistAtLoc(int ithLocation)

gets the Hypocenter Mag.

Parameters:

ithLocation - int : Index of the location in the region

Returns:

HypoMagFreqDistAtLoc Object using which user can retrieve the Magnitude Frequency Distribution.