org.opensha.sha.calc.params
Class PtSrcDistanceCorrectionParam

java.lang.Object
  extended by org.opensha.commons.param.AbstractParameter<String>
      extended by org.opensha.commons.param.impl.StringParameter
          extended by org.opensha.sha.calc.params.PtSrcDistanceCorrectionParam
All Implemented Interfaces:
Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<String>

public class PtSrcDistanceCorrectionParam
extends StringParameter

This parameter allows one to choose a type of point source distance correction. This should really be implemented as an enum parameter.

See Also:
Serialized Form

Field Summary
static String INFO
           
static String NAME
           
static String PT_SRC_DIST_CORR_FIELD
           
static String PT_SRC_DIST_CORR_NONE
           
static String PT_SRC_DIST_CORR_NSHMP08
           
 
Fields inherited from class org.opensha.commons.param.impl.StringParameter
C, D
 
Fields inherited from class org.opensha.commons.param.AbstractParameter
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
 
Constructor Summary
PtSrcDistanceCorrectionParam()
          The parameter is set as non editable after creation
 
Method Summary
 PtSrcDistCorr.Type getValueAsTypePtSrcDistCorr()
          This returns the value as PtSrcDistCorr.Type enum
 void setValueFromTypePtSrcDistCorr(PtSrcDistCorr.Type type)
          Set the value from a PtSrcDistCorr.Type enum
 
Methods inherited from class org.opensha.commons.param.impl.StringParameter
clone, getAllowedStrings, getEditor, getType, setConstraint, setIndividualParamValueFromXML
 
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, isAllowed, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setDefaultValue, setDependentParamMetadataString, setIndependentParameters, setIndepParamsFromXML, setInfo, setName, setNonEditable, setUnits, setValue, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, toXMLMetadata, unableToSetValue, valueToXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values

INFO

public static final String INFO
See Also:
Constant Field Values

PT_SRC_DIST_CORR_NONE

public static final String PT_SRC_DIST_CORR_NONE
See Also:
Constant Field Values

PT_SRC_DIST_CORR_FIELD

public static final String PT_SRC_DIST_CORR_FIELD
See Also:
Constant Field Values

PT_SRC_DIST_CORR_NSHMP08

public static final String PT_SRC_DIST_CORR_NSHMP08
See Also:
Constant Field Values
Constructor Detail

PtSrcDistanceCorrectionParam

public PtSrcDistanceCorrectionParam()
The parameter is set as non editable after creation

Parameters:
options -
defaultValue -
Method Detail

getValueAsTypePtSrcDistCorr

public PtSrcDistCorr.Type getValueAsTypePtSrcDistCorr()
This returns the value as PtSrcDistCorr.Type enum

Returns:

setValueFromTypePtSrcDistCorr

public void setValueFromTypePtSrcDistCorr(PtSrcDistCorr.Type type)
Set the value from a PtSrcDistCorr.Type enum