org.opensha.sha.gcim.imr.param.IntensityMeasureParams
Class CAV_Param

java.lang.Object
  extended by org.opensha.commons.param.AbstractParameter<Double>
      extended by org.opensha.commons.param.impl.DoubleParameter
          extended by org.opensha.commons.param.impl.WarningDoubleParameter
              extended by org.opensha.sha.gcim.imr.param.IntensityMeasureParams.CAV_Param
All Implemented Interfaces:
Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<Double>, WarningParameter<Double>

public class CAV_Param
extends WarningDoubleParameter

This constitutes the natural-log Cumulative Absolute Velocity intensity measure parameter, defined as CAV = integral{abs(a(t))}, where a(t) is the acceleration time history; abs() is absolute value; and the integral is over the entire duration of the time history See constructors for info on editability and default values.

Author:
Brendon Bradley Oct 2010
See Also:
Serialized Form

Field Summary
static Double DEFAULT_WARN_MAX
           
static Double DEFAULT_WARN_MIN
           
static String INFO
           
static Double MAX
           
static Double MIN
           
static String NAME
           
static String UNITS
           
 
Fields inherited from class org.opensha.commons.param.impl.WarningDoubleParameter
C, D, warningConstraint, warningListeners
 
Fields inherited from class org.opensha.commons.param.AbstractParameter
constraint, defaultValue, editable, independentParameters, info, metadataString, name, units, value, XML_COMPLEX_VAL_EL_NAME, XML_GROUP_METADATA_NAME, XML_METADATA_NAME, XML_NULL_VALUE
 
Fields inherited from interface org.opensha.commons.param.Parameter
XML_INDEPENDENT_PARAMS_NAME
 
Fields inherited from interface org.opensha.commons.metadata.XMLSaveable
XML_METADATA_NAME
 
Constructor Summary
CAV_Param()
          This uses the DEFAULT_WARN_MIN and DEFAULT_WARN_MAX fields to set the warning constraint, and sets the default as Math.log(0.3) (the natural log of 0.3).
CAV_Param(DoubleConstraint warningConstraint, double defaultCAV)
          This uses the supplied warning constraint and default (both in natural-log space).
 
Method Summary
 
Methods inherited from class org.opensha.commons.param.impl.WarningDoubleParameter
addParameterChangeWarningListener, clone, fireParameterChangeWarning, getWarningConstraint, getWarningMax, getWarningMin, isIgnoreWarning, isRecommended, removeParameterChangeWarningListener, setIgnoreWarning, setIndividualParamValueFromXML, setValue, setValueIgnoreWarning, setWarningConstraint
 
Methods inherited from class org.opensha.commons.param.impl.DoubleParameter
getEditor, getMax, getMin, getType, isAllowed, setConstraint, setValue
 
Methods inherited from class org.opensha.commons.param.AbstractParameter
addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, checkEditable, compareTo, containsIndependentParameter, equals, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getIndependentParameter, getIndependentParameterList, getIndependentParametersKey, getInfo, getMetadataString, getName, getNumIndependentParameters, getUnits, getValue, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setDefaultValue, setDependentParamMetadataString, setIndependentParameters, setIndepParamsFromXML, setInfo, setName, setNonEditable, setUnits, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, toXMLMetadata, unableToSetValue, valueToXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensha.commons.param.WarningParameter
equals
 
Methods inherited from interface org.opensha.commons.param.Parameter
addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, containsIndependentParameter, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getEditor, getIndependentParameter, getIndependentParameterList, getIndependentParametersKey, getInfo, getMetadataString, getNumIndependentParameters, getType, getUnits, getValue, isAllowed, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setConstraint, setDefaultValue, setIndependentParameters, setInfo, setName, setNonEditable, setUnits, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, unableToSetValue
 
Methods inherited from interface org.opensha.commons.data.Named
getName
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface org.opensha.commons.metadata.XMLSaveable
toXMLMetadata
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values

UNITS

public static final String UNITS
See Also:
Constant Field Values

INFO

public static final String INFO
See Also:
Constant Field Values

MIN

public static final Double MIN

MAX

public static final Double MAX

DEFAULT_WARN_MIN

public static final Double DEFAULT_WARN_MIN

DEFAULT_WARN_MAX

public static final Double DEFAULT_WARN_MAX
Constructor Detail

CAV_Param

public CAV_Param(DoubleConstraint warningConstraint,
                 double defaultCAV)
This uses the supplied warning constraint and default (both in natural-log space). The parameter is left as non editable

Parameters:
warningConstraint -
defaultCAV -

CAV_Param

public CAV_Param()
This uses the DEFAULT_WARN_MIN and DEFAULT_WARN_MAX fields to set the warning constraint, and sets the default as Math.log(0.3) (the natural log of 0.3). The parameter is left as non editable