org.opensha.sha.earthquake
Class EqkRupture

java.lang.Object
  extended by org.opensha.sha.earthquake.EqkRupture
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ObsEqkRupture, ProbEqkRupture

public class EqkRupture
extends java.lang.Object
implements java.io.Serializable

Title: EqkRupture
Description:

Version:
1.0
Author:
Sid Hellman
See Also:
Serialized Form

Field Summary
protected  double aveRake
           
protected static java.lang.String C
           
protected static boolean D
           
protected  Location hypocenterLocation
           
protected  double mag
           
protected  ParameterList otherParams
          object to contain arbitrary parameters
protected  RuptureSurface ruptureSurface
          object to specify Rupture distribution and AveDip
 
Constructor Summary
EqkRupture()
           
EqkRupture(double mag, double aveRake, RuptureSurface ruptureSurface, Location hypocenterLocation)
           
 
Method Summary
 void addParameter(Parameter<?> parameter)
          This function doesn't create the ParameterList until the first attempt to add a parameter is added.
 java.util.ListIterator<Parameter<?>> getAddedParametersIterator()
          SWR - Not crazy about the name, why not just getParametersIterator(), same as the ParameterList it is calling.
 double getAveRake()
           
 Location getHypocenterLocation()
           
 java.lang.String getInfo()
           
 double getMag()
           
 RuptureSurface getRuptureSurface()
           
 void removeParameter(Parameter<?> parameter)
           
 void setAveRake(double aveRake)
           
 void setHypocenterLocation(Location h)
           
 void setMag(double mag)
           
 void setPointSurface(Location location)
           
 void setPointSurface(Location location, double aveDip)
           
 void setPointSurface(Location location, double aveStrike, double aveDip)
           
 void setPointSurface(PointSurface pointSurface)
           
 void setRuptureSurface(RuptureSurface r)
          Note: Since this takes a GriddedSurfaceAPI both a PointSurface and GriddedSurface can be set here
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

C

protected static final java.lang.String C
See Also:
Constant Field Values

D

protected static final boolean D
See Also:
Constant Field Values

mag

protected double mag

aveRake

protected double aveRake

hypocenterLocation

protected Location hypocenterLocation

ruptureSurface

protected RuptureSurface ruptureSurface
object to specify Rupture distribution and AveDip


otherParams

protected ParameterList otherParams
object to contain arbitrary parameters

Constructor Detail

EqkRupture

public EqkRupture()

EqkRupture

public EqkRupture(double mag,
                  double aveRake,
                  RuptureSurface ruptureSurface,
                  Location hypocenterLocation)
           throws InvalidRangeException
Throws:
InvalidRangeException
Method Detail

addParameter

public void addParameter(Parameter<?> parameter)
This function doesn't create the ParameterList until the first attempt to add a parameter is added. This is known as Lazy Instantiation, where the class is not created until needed. This is a common performance enhancement, because in general, not all aspects of a program are used per user session.


removeParameter

public void removeParameter(Parameter<?> parameter)

getAddedParametersIterator

public java.util.ListIterator<Parameter<?>> getAddedParametersIterator()
SWR - Not crazy about the name, why not just getParametersIterator(), same as the ParameterList it is calling. People don't know that they have been Added, this doesn't convey any more information than the short name to me.


getMag

public double getMag()

setMag

public void setMag(double mag)

getAveRake

public double getAveRake()

setAveRake

public void setAveRake(double aveRake)
                throws InvalidRangeException
Throws:
InvalidRangeException

getRuptureSurface

public RuptureSurface getRuptureSurface()

setRuptureSurface

public void setRuptureSurface(RuptureSurface r)
Note: Since this takes a GriddedSurfaceAPI both a PointSurface and GriddedSurface can be set here


getHypocenterLocation

public Location getHypocenterLocation()

setHypocenterLocation

public void setHypocenterLocation(Location h)

setPointSurface

public void setPointSurface(Location location)

setPointSurface

public void setPointSurface(Location location,
                            double aveDip)

setPointSurface

public void setPointSurface(Location location,
                            double aveStrike,
                            double aveDip)

setPointSurface

public void setPointSurface(PointSurface pointSurface)

getInfo

public java.lang.String getInfo()