org.opensha.sha.imr.param.SiteParams
Class Vs30_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.imr.param.SiteParams.Vs30_Param
All Implemented Interfaces:
Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<Double>, WarningParameter<Double>

public class Vs30_Param
extends WarningDoubleParameter

Vs30 Parameter, reserved for representing the average shear-wave velocity in the upper 30 meters of a site (a commonly used parameter). The warning constraint must be created and added when instantiated. See constructors for info on editability and default values.

See Also:
Serialized Form

Field Summary
static String INFO
           
protected static Double MAX
           
protected 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
Vs30_Param()
          This constructor sets the default value as 760 m/sec and leaves the param editable so the warning constraint can be added.
Vs30_Param(double defaultValue)
          This constructor sets the default value as given and leaves the param editable so the warning constraint can be added.
Vs30_Param(double warnMin, double warnMax)
          This constructor sets the default as 760 m/sec, the warning constraint as given, and sets everything as non-editable.
Vs30_Param(double defaultValue, double warnMin, double warnMax)
          This constructor sets the default and warning constraint as given, and sets everything as non-editable.
 
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

protected static final Double MIN

MAX

protected static final Double MAX
Constructor Detail

Vs30_Param

public Vs30_Param(double defaultValue)
This constructor sets the default value as given and leaves the param editable so the warning constraint can be added.


Vs30_Param

public Vs30_Param()
This constructor sets the default value as 760 m/sec and leaves the param editable so the warning constraint can be added.


Vs30_Param

public Vs30_Param(double defaultValue,
                  double warnMin,
                  double warnMax)
This constructor sets the default and warning constraint as given, and sets everything as non-editable.

Parameters:
warnMin -
warnMax -

Vs30_Param

public Vs30_Param(double warnMin,
                  double warnMax)
This constructor sets the default as 760 m/sec, the warning constraint as given, and sets everything as non-editable.

Parameters:
warnMin -
warnMax -