org.opensha.sha.imr.param.OtherParams
Class StdDevTypeParam

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

public class StdDevTypeParam
extends StringParameter

StdDevTypeParam represents the various types of standard deviations that an IMR might support The constraint must be provided in the constructor, and the "STD_DEV_TYPE_*" strings here represent common options that can be used in creating the constraint (although other unique options can be added as well). "InterEvent" is the event to event variability, "Intra-Event" is the variability within an event, and "Total" (the most common) is the other two two added in quadrature. Other options should be self explanatory. See constructors for info on editability and default values.

See Also:
Serialized Form

Field Summary
static java.lang.String INFO
           
static java.lang.String NAME
           
static java.lang.String STD_DEV_TYPE_INTER
           
static java.lang.String STD_DEV_TYPE_INTRA
           
static java.lang.String STD_DEV_TYPE_INTRA_MAG_DEP
           
static java.lang.String STD_DEV_TYPE_NONE
           
static java.lang.String STD_DEV_TYPE_TOTAL
           
static java.lang.String STD_DEV_TYPE_TOTAL_MAG_DEP
           
static java.lang.String STD_DEV_TYPE_TOTAL_PGA_DEP
           
 
Fields inherited from class org.opensha.commons.param.impl.StringParameter
C, D
 
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
 
Constructor Summary
StdDevTypeParam(StringConstraint options)
          This sets the default as STD_DEV_TYPE_TOTAL (and will throw and exception if that value is not in the options list).
StdDevTypeParam(StringConstraint options, java.lang.String defaultValue)
          This one allows you to set the default (overriding how its set in the other constructor).
 
Method Summary
 
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 java.lang.String NAME
See Also:
Constant Field Values

INFO

public static final java.lang.String INFO
See Also:
Constant Field Values

STD_DEV_TYPE_TOTAL

public static final java.lang.String STD_DEV_TYPE_TOTAL
See Also:
Constant Field Values

STD_DEV_TYPE_INTER

public static final java.lang.String STD_DEV_TYPE_INTER
See Also:
Constant Field Values

STD_DEV_TYPE_INTRA

public static final java.lang.String STD_DEV_TYPE_INTRA
See Also:
Constant Field Values

STD_DEV_TYPE_NONE

public static final java.lang.String STD_DEV_TYPE_NONE
See Also:
Constant Field Values

STD_DEV_TYPE_TOTAL_MAG_DEP

public static final java.lang.String STD_DEV_TYPE_TOTAL_MAG_DEP
See Also:
Constant Field Values

STD_DEV_TYPE_TOTAL_PGA_DEP

public static final java.lang.String STD_DEV_TYPE_TOTAL_PGA_DEP
See Also:
Constant Field Values

STD_DEV_TYPE_INTRA_MAG_DEP

public static final java.lang.String STD_DEV_TYPE_INTRA_MAG_DEP
See Also:
Constant Field Values
Constructor Detail

StdDevTypeParam

public StdDevTypeParam(StringConstraint options)
This sets the default as STD_DEV_TYPE_TOTAL (and will throw and exception if that value is not in the options list). The parameter is set as non editable after creation.

Parameters:
options -

StdDevTypeParam

public StdDevTypeParam(StringConstraint options,
                       java.lang.String defaultValue)
This one allows you to set the default (overriding how its set in the other constructor). The parameter is set as non editable after creation.

Parameters:
options -