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

java.lang.Object
  org.opensha.commons.param.AbstractParameter<String>
      org.opensha.commons.param.impl.StringParameter
          org.opensha.sha.imr.param.OtherParams.SigmaTruncTypeParam

All Implemented Interfaces:

Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<String>

public class SigmaTruncTypeParam
extends StringParameter

SigmaTruncTypeParam, a StringParameter that represents the type of truncation to be applied to the probability distribution. The constraint/options are hard-coded here because changes will require changes in the probability calculations elsewhere in the code. The parameter is left non editable

See Also:

Serialized Form

Field Summary

static String	INFO
static String	NAME
static String	SIGMA_TRUNC_TYPE_1SIDED
static String	SIGMA_TRUNC_TYPE_2SIDED
static String	SIGMA_TRUNC_TYPE_NONE

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

SigmaTruncTypeParam()
This constructor invokes the standard options ("None", "1 Sided", or "2 Sided"), and sets the default as "None".

SigmaTruncTypeParam(String defaultValue)
This constructor invokes the standard options ("None", "1 Sided", or "2 Sided"), and uses the given default value.

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, getIndependentParametersIterator, 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

SIGMA_TRUNC_TYPE_NONE

public static final String SIGMA_TRUNC_TYPE_NONE

See Also:

Constant Field Values

SIGMA_TRUNC_TYPE_1SIDED

public static final String SIGMA_TRUNC_TYPE_1SIDED

See Also:

Constant Field Values

SIGMA_TRUNC_TYPE_2SIDED

public static final String SIGMA_TRUNC_TYPE_2SIDED

See Also:

Constant Field Values

Constructor Detail

SigmaTruncTypeParam

public SigmaTruncTypeParam()

This constructor invokes the standard options ("None", "1 Sided", or "2 Sided"), and sets the default as "None". The parameter is left non editable.

SigmaTruncTypeParam

public SigmaTruncTypeParam(String defaultValue)

This constructor invokes the standard options ("None", "1 Sided", or "2 Sided"), and uses the given default value. The parameter is left non editable.