org.opensha.sha.cybershake.openshaAPIs
Class CyberShakeProbEqkSource

java.lang.Object
  extended by org.opensha.sha.earthquake.ProbEqkSource
      extended by org.opensha.sha.cybershake.openshaAPIs.CyberShakeProbEqkSource
All Implemented Interfaces:
Serializable, Iterable<ProbEqkRupture>, Named, EqkSource

public class CyberShakeProbEqkSource
extends ProbEqkSource

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.opensha.sha.earthquake.ProbEqkSource
isPoissonian, name
 
Constructor Summary
CyberShakeProbEqkSource(ProbEqkSource source, int sourceID, int erfID)
           
CyberShakeProbEqkSource(String name)
           
 
Method Summary
 void addRupture(CyberShakeEqkRupture rup)
           
 LocationList getAllSourceLocs()
          It returns a list of all the locations which make up the surface for this source.
 double getMinDistance(Site site)
          This computes some measure of the minimum distance between the source and the site passed in.
 int getNumRuptures()
          Get the number of ruptures for this source
 ProbEqkRupture getRupture(int rupture)
          Get the ith rupture for this source This is a handle(or reference) to existing class variable.
 RuptureSurface getSourceSurface()
          This gives the entire surface of the source
 boolean isPoissonianSource()
          Checks if the source is Poission.
 
Methods inherited from class org.opensha.sha.earthquake.ProbEqkSource
computeApproxTotalProbAbove, computeEquivTotalMomentRate, computeTotalEquivMeanAnnualRate, computeTotalProb, computeTotalProbAbove, computeTotalProbAbove, drawRandomEqkRuptureIndices, drawRandomEqkRuptures, drawSingleRandomEqkRuptureIndex, drawSingleRandomEqkRuptureIndex, getInfo, getName, getRuptureClone, getRuptureList, getRupturesIterator, getSourceMetadata, getTectonicRegionType, isSourcePoissonian, iterator, setInfo, setTectonicRegionType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CyberShakeProbEqkSource

public CyberShakeProbEqkSource(String name)

CyberShakeProbEqkSource

public CyberShakeProbEqkSource(ProbEqkSource source,
                               int sourceID,
                               int erfID)
Method Detail

addRupture

public void addRupture(CyberShakeEqkRupture rup)

getMinDistance

public double getMinDistance(Site site)
Description copied from class: ProbEqkSource
This computes some measure of the minimum distance between the source and the site passed in. This is useful for ignoring sources that are at great distanced from a site of interest. Actual implementation depend on subclass.

Specified by:
getMinDistance in class ProbEqkSource
Returns:
minimum distance

getNumRuptures

public int getNumRuptures()
Description copied from class: ProbEqkSource
Get the number of ruptures for this source

Specified by:
getNumRuptures in interface EqkSource
Specified by:
getNumRuptures in class ProbEqkSource
Returns:
returns an integer value specifying the number of ruptures for this source

getRupture

public ProbEqkRupture getRupture(int rupture)
Description copied from class: ProbEqkSource
Get the ith rupture for this source This is a handle(or reference) to existing class variable. If this function is called again, then output from previous function call will not remain valid because of passing by reference It is a secret, fast but dangerous method

Specified by:
getRupture in interface EqkSource
Specified by:
getRupture in class ProbEqkSource

getAllSourceLocs

public LocationList getAllSourceLocs()
Description copied from interface: EqkSource
It returns a list of all the locations which make up the surface for this source.

Returns:
LocationList - List of all the locations which constitute the surface of this source

getSourceSurface

public RuptureSurface getSourceSurface()
Description copied from interface: EqkSource
This gives the entire surface of the source

Returns:

isPoissonianSource

public boolean isPoissonianSource()
Description copied from class: ProbEqkSource
Checks if the source is Poission.

Overrides:
isPoissonianSource in class ProbEqkSource
Returns:
boolean