org.opensha.sha.imr.param.IntensityMeasureParams
Class DampingParam

java.lang.Object
  org.opensha.commons.param.AbstractParameter<Double>
      org.opensha.commons.param.impl.DoubleDiscreteParameter
          org.opensha.sha.imr.param.IntensityMeasureParams.DampingParam

All Implemented Interfaces:

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

public class DampingParam
extends DoubleDiscreteParameter

This represents Damping for the Spectral Acceleration parameter (SA_Param). The constructor requires a list of supported damping levels (in the form of a DoubleDiscreteConstraint). Once instantiated, this can be added to the SA_Param as an independent parameter. See constructors for info on editability and default values.

Author:

field

See Also:

Serialized Form

Field Summary

static String	INFO
static String	NAME
static String	UNITS

Fields inherited from class org.opensha.commons.param.impl.DoubleDiscreteParameter

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

Fields inherited from interface org.opensha.commons.metadata.XMLSaveable

XML_METADATA_NAME

Constructor Summary

DampingParam()
This constructor assumes that only 5% damping is supported, and sets this as the default.

DampingParam(DoubleDiscreteConstraint dampingConstraint)
This sets the default as 5%, and leaves the parameter non-editable

DampingParam(DoubleDiscreteConstraint dampingConstraint, double defaultDamping)
This leaves the parameter non editable

Method Summary

Methods inherited from class org.opensha.commons.param.impl.DoubleDiscreteParameter

clone, getAllowedDoubles, 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

Methods inherited from interface org.opensha.commons.param.Parameter

addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, containsIndependentParameter, equals, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getIndependentParameter, getIndependentParametersIterator, getIndependentParametersKey, getInfo, getMetadataString, getNumIndependentParameters, getUnits, getValue, isAllowed, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setDefaultValue, setIndependentParameters, setInfo, setName, setNonEditable, setUnits, setValue, 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

Constructor Detail

DampingParam

public DampingParam(DoubleDiscreteConstraint dampingConstraint,
                    double defaultDamping)

This leaves the parameter non editable

Parameters:

dampingConstraint -

defaultDamping -

DampingParam

public DampingParam(DoubleDiscreteConstraint dampingConstraint)

This sets the default as 5%, and leaves the parameter non-editable

Parameters:

dampingConstraint -

DampingParam

public DampingParam()

This constructor assumes that only 5% damping is supported, and sets this as the default. The parameter is left non editable.