org.opensha.sha.earthquake
Interface EqkSource

All Superinterfaces:
Named, Serializable
All Known Implementing Classes:
CEUS_Point2Vert_FaultPoisSource, ClusterSource, CyberShakeProbEqkSource, FaultRuptureSource, FaultSource, FixedStrikeSource, FloatingPoissonFaultSource, Frankel02_TypeB_EqkSource, Frankel96_CharEqkSource, Frankel96_GR_EqkSource, GriddedRegionPoissonEqkSource, Point2MultVertSS_FaultSource, Point2Vert_FaultPoisSource, Point2Vert_SS_FaultPoisSource, PointEqkSource, PointSource, PointSource13, PointSource13b, PointToLineSource, PointToLineSource_old, PoissonAreaSource, ProbEqkSource, SubductionSource, UnsegmentedSource, WG02_CharEqkSource

public interface EqkSource
extends Named, Serializable

Title: EqkSourceAPI

Description: THis interface is for getting rupture information about each earhquake source

Version:
1.0
Author:
Nitin Gupta & Vipin Gupta

Method Summary
 LocationList getAllSourceLocs()
          It returns a list of all the locations which make up the surface for this source.
 int getNumRuptures()
          Get the number of ruptures for this source
 ProbEqkRupture getRupture(int nRupture)
          Get the ith rupture for this source This is a handle(or reference) to existing class variable.
 ProbEqkRupture getRuptureClone(int nRupture)
          this function can be used if a clone is wanted instead of handle to class variable Subsequent calls to this function will not affect the result got previously.
 List<ProbEqkRupture> getRuptureList()
          Returns the ArrayList consisting of all ruptures for this source all the objects are cloned.
 Iterator<ProbEqkRupture> getRupturesIterator()
          Get the iterator over all ruptures
 RuptureSurface getSourceSurface()
          This gives the entire surface of the source
 TectonicRegionType getTectonicRegionType()
          This identifies the type of tectonic region the source is associate with.
 
Methods inherited from interface org.opensha.commons.data.Named
getName
 

Method Detail

getRupturesIterator

Iterator<ProbEqkRupture> getRupturesIterator()
Get the iterator over all ruptures

Returns:
Iterator on vector for all ruptures

getNumRuptures

int getNumRuptures()
Get the number of ruptures for this source

Returns:
returns an integer value specifying the number of ruptures for this source

getRupture

ProbEqkRupture getRupture(int nRupture)
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

Parameters:
i - ith rupture

getRuptureClone

ProbEqkRupture getRuptureClone(int nRupture)
this function can be used if a clone is wanted instead of handle to class variable Subsequent calls to this function will not affect the result got previously. This is in contrast with the getRupture(int i) function

Parameters:
i -
Returns:

getRuptureList

List<ProbEqkRupture> getRuptureList()
Returns the ArrayList consisting of all ruptures for this source all the objects are cloned. so this vector can be saved by the user

Returns:
ArrayList consisting of

getAllSourceLocs

LocationList getAllSourceLocs()
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

RuptureSurface getSourceSurface()
This gives the entire surface of the source

Returns:

getTectonicRegionType

TectonicRegionType getTectonicRegionType()
This identifies the type of tectonic region the source is associate with. This should return one of the TYPE_* variables defined in the class org.opensha.sha.imr.param.OtherParams.TectonicRegionTypeParam;