Package ffx.xray

Enum Class SplineEnergy.SplineType

java.lang.Object

java.lang.Enum<SplineEnergy.SplineType>

ffx.xray.SplineEnergy.SplineType

All Implemented Interfaces:

Serializable, Comparable<SplineEnergy.SplineType>, Constable

Enclosing class:

SplineEnergy

public static enum SplineEnergy.SplineType
extends Enum<SplineEnergy.SplineType>

The SplineType enum represents types of splines that can be used in X-ray diffraction energy calculations within the context of the SplineEnergy class. Each constant corresponds to a specific mathematical or computational formulation of a spline used for handling structure factor data.

FOFC Spline Fo to Fc F1F2 Spline F1 to F2 FCTOESQ Spline Fc to ESQ FOTOESQ Spline Fo to ESQ

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
F1F2
FCTOESQ
FOFC
FOTOESQ

Method Summary

Modifier and Type	Method	Description
String	toString()
static SplineEnergy.SplineType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SplineEnergy.SplineType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FOFC

public static final SplineEnergy.SplineType FOFC

F1F2

public static final SplineEnergy.SplineType F1F2

FCTOESQ

public static final SplineEnergy.SplineType FCTOESQ

FOTOESQ

public static final SplineEnergy.SplineType FOTOESQ

Method Details

values

public static SplineEnergy.SplineType[] 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 SplineEnergy.SplineType 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

toString

public String toString()

Overrides:

toString in class Enum<SplineEnergy.SplineType>