Package ffx.potential.bonded

Enum Class RotamerLibrary.NucleicSugarPucker

java.lang.Object

java.lang.Enum<RotamerLibrary.NucleicSugarPucker>

ffx.potential.bonded.RotamerLibrary.NucleicSugarPucker

All Implemented Interfaces:

Serializable, Comparable<RotamerLibrary.NucleicSugarPucker>, Constable

Enclosing class:

RotamerLibrary

public static enum RotamerLibrary.NucleicSugarPucker
extends Enum<RotamerLibrary.NucleicSugarPucker>

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
C2_ENDO
C3_ENDO
C3_EXO

Method Summary

Modifier and Type	Method	Description
static RotamerLibrary.NucleicSugarPucker	checkPucker(double delta, boolean isDeoxy)	Returns the sugar pucker associated with a delta torsion.
static RotamerLibrary.NucleicSugarPucker	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RotamerLibrary.NucleicSugarPucker[]	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

C2_ENDO

public static final RotamerLibrary.NucleicSugarPucker C2_ENDO

C3_ENDO

public static final RotamerLibrary.NucleicSugarPucker C3_ENDO

C3_EXO

public static final RotamerLibrary.NucleicSugarPucker C3_EXO

Method Details

values

public static RotamerLibrary.NucleicSugarPucker[] 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 RotamerLibrary.NucleicSugarPucker 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

checkPucker

public static RotamerLibrary.NucleicSugarPucker checkPucker(double delta,
 boolean isDeoxy)

Returns the sugar pucker associated with a delta torsion. This currently does not support the C3'-exo DNA-only pucker.

Parameters:

delta - Delta torsion to check

isDeoxy - If DNA (vs. RNA). Presently ignored.

Returns:

Pucker