org.opensha.sha.imr.param.PropagationEffectParams
Interface PropagationEffectParameterAPI<E>

All Known Implementing Classes:
AbstractDoublePropEffectParam, DistanceJBParameter, DistanceRupParameter, DistanceSeisParameter, DistanceX_Parameter, DistRupMinusJB_OverRupParameter, PropagationEffectParameter, WarningDoublePropagationEffectParameter

public interface PropagationEffectParameterAPI<E>

Title: PropagationEffectParameterAPI

Description: Interface that PropagationEffect Parameters must implement.

Propagation Effect Parameters are a specific subclass of parameters that deal with earthquake probability variables. Their defining characteristics are that they take two independent variables, a Site and ProbEqkRupture and then can calculate their own value. Their use is distinct from regular parameters in that setValue() is typically not called. That is the only way to set standard parameters.

This API defines several gatValue() functions that take different combinations of Site and ProbEqkRupture that will make this parameter recalculate itself, returning the new value.

Version:
1.0
Author:
Steven W. Rock

Method Summary
 E getValue(EqkRupture eqkRupture, Site site)
          Sets the independent variables (Site and eqkRupture) then calculates and returns the value
 void setValue(EqkRupture eqkRupture, Site site)
          Sets the independent variables (Site and EqkRupture) then calculates the value
 

Method Detail

getValue

E getValue(EqkRupture eqkRupture,
           Site site)
Sets the independent variables (Site and eqkRupture) then calculates and returns the value


setValue

void setValue(EqkRupture eqkRupture,
              Site site)
Sets the independent variables (Site and EqkRupture) then calculates the value