org.opensha.sha.imr.param.PropagationEffectParams
Class HangingWallFlagParam

java.lang.Object
  org.opensha.commons.param.AbstractParameter<Boolean>
      org.opensha.commons.param.impl.BooleanParameter
          org.opensha.sha.imr.param.PropagationEffectParams.HangingWallFlagParam

All Implemented Interfaces:

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

public class HangingWallFlagParam
extends BooleanParameter

HangingWallFlagParam parameter - indicates whether a site is on the hanging wall of a rupture surface. Exact definition and setting of value must be handled in the implementing class. See constructors for info on editability and default values.

See Also:

Serialized Form

Field Summary

static String	INFO
static String	NAME

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

C, D, PARAM_TYPE

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

HangingWallFlagParam()
This sets the default value as "false", and leaves the parameter non editable.

HangingWallFlagParam(boolean defaultValue)
This sets the default value as given, and leaves the parameter non editable.

Method Summary

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

clone, getEditor, getType, isNullAllowed, 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, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setConstraint, 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

Constructor Detail

HangingWallFlagParam

public HangingWallFlagParam(boolean defaultValue)

This sets the default value as given, and leaves the parameter non editable.

Parameters:

defaultValue -

HangingWallFlagParam

public HangingWallFlagParam()

This sets the default value as "false", and leaves the parameter non editable.

Parameters:

defaultValue -