Package ffx.xray.solvent

Enum Class SolventModel

java.lang.Object

java.lang.Enum<SolventModel>

ffx.xray.solvent.SolventModel

All Implemented Interfaces:

Serializable, Comparable<SolventModel>, Constable

public enum SolventModel
extends Enum<SolventModel>

Enum representing different solvent modeling approaches.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	The classic binary (0, 1) model.
GAUSSIAN	Smooth the boundary of the classic model using Gaussians.
NONE	Do not model solvent scattering.
POLYNOMIAL	Smooth the boundar of the classic model using a cubic polynomial switch (default).

Method Summary

Modifier and Type	Method	Description
static SolventModel	parse(String solventName)	Parse a solvent model string and return a SolventModel enum.
static SolventModel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SolventModel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SolventModel NONE

Do not model solvent scattering.

BINARY

public static final SolventModel BINARY

The classic binary (0, 1) model.

GAUSSIAN

public static final SolventModel GAUSSIAN

Smooth the boundary of the classic model using Gaussians.

POLYNOMIAL

public static final SolventModel POLYNOMIAL

Smooth the boundar of the classic model using a cubic polynomial switch (default).

Method Details

values

public static SolventModel[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SolventModel valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

parse

public static SolventModel parse(String solventName)

Parse a solvent model string and return a SolventModel enum.

Parameters:

solventName - The solvent model String.

Returns:

The SolventModel to use.