gov.usgs.earthquake.nshmp.eq.model

Interface SourceSet<T extends Source>

All Superinterfaces:

Comparable<SourceSet<T>>, Iterable<T>, Named

All Known Implementing Classes:

AreaSourceSet, ClusterSourceSet, FaultSourceSet, GridSourceSet, InterfaceSourceSet, SlabSourceSet, SystemSourceSet

public interface SourceSet<T extends Source>
extends Named, Iterable<T>, Comparable<SourceSet<T>>

Wrapper class for groups of Sources of similar SourceType. The use of the word 'Set' in the class name implies the Sources in a SourceSet will be unique, but no steps are taken to enforce this.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
Predicate<T>	distanceFilter(Location loc, double distance) Return a Predicate that evaluates to true if this source is within distance of the supplied Location.
GmmSet	groundMotionModels() Return the GroundMotionModels associated with this SourceSet as a GmmSet.
int	id() A unique integer id.
Iterable<T>	iterableForLocation(Location loc) Return an Iterable over those Sources that are within the cutoff distance of the supplied Location.
Iterable<T>	iterableForLocation(Location loc, double distance) Return an Iterable over those Sources that are within distance of the supplied Location.
int	size() The number of Sources in this SourceSet.
SourceType	type() The SourceType identifier.
double	weight() The weight applicable to this SourceSet.

Methods inherited from interface gov.usgs.earthquake.nshmp.util.Named

name

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

id

int id()

A unique integer id.

type

SourceType type()

The SourceType identifier.

size

int size()

The number of Sources in this SourceSet.

weight

double weight()

The weight applicable to this SourceSet.

iterableForLocation

Iterable<T> iterableForLocation(Location loc)

Return an Iterable over those Sources that are within the cutoff distance of the supplied Location. The cutoff distance is derived from the GroundMotionModels associated with this SourceSet.

Parameters:

loc - Location of interest

iterableForLocation

Iterable<T> iterableForLocation(Location loc,
                                double distance)

Return an Iterable over those Sources that are within distance of the supplied Location.

Parameters:

loc - Location of interest

distance - limit

distanceFilter

Predicate<T> distanceFilter(Location loc,
                            double distance)

Return a Predicate that evaluates to true if this source is within distance of the supplied Location. This Predicate performs a quick distance calculation and is used to determine whether this source should be included in a hazard calculation.

Parameters:

loc - Location of interest

distance - limit

groundMotionModels

GmmSet groundMotionModels()

Return the GroundMotionModels associated with this SourceSet as a GmmSet.

See Also:

GmmSet