org.opensha.sha.imr.param.EqkRuptureParams
Class MagParam

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.EqkRuptureParams.MagParam
All Implemented Interfaces:
Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<Double>, WarningParameter<Double>

public class MagParam
extends WarningDoubleParameter

Magnitude parameter, reserved for representing moment magnitude. The warning constraint must be created and added after instantiation. 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
           
 
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
MagParam()
          This sets the default value as 5.5.
MagParam(double defaultMag)
          This sets the default value as given.
MagParam(double minWarning, double maxWarning)
          This sets the default value as 5.5, and applies the given warning- constraint limits.
MagParam(double minWarning, double maxWarning, double defaultMag)
          This sets the default value and warning-constraint limits as given, and leaves the parameter 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

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

MagParam

public MagParam(double minWarning,
                double maxWarning,
                double defaultMag)
This sets the default value and warning-constraint limits as given, and leaves the parameter as non editable.


MagParam

public MagParam(double minWarning,
                double maxWarning)
This sets the default value as 5.5, and applies the given warning- constraint limits. The parameter is left as non editable.


MagParam

public MagParam(double defaultMag)
This sets the default value as given. No warning limits are set, so this is left editable so warning constraints can be added.


MagParam

public MagParam()
This sets the default value as 5.5. No warning limits are set, so this is left editable so warning constraints can be added.