Package ffx.potential.parameters

Enum Class MultipoleType.MultipoleFrameDefinition

java.lang.Object

java.lang.Enum<MultipoleType.MultipoleFrameDefinition>

ffx.potential.parameters.MultipoleType.MultipoleFrameDefinition

All Implemented Interfaces:

Serializable, Comparable<MultipoleType.MultipoleFrameDefinition>, Constable

Enclosing class:

MultipoleType

public static enum MultipoleType.MultipoleFrameDefinition
extends Enum<MultipoleType.MultipoleFrameDefinition>

The local multipole frame is defined by the Z-then-X or Bisector convention.

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
BISECTOR
NONE
THREEFOLD
ZONLY
ZTHENBISECTOR
ZTHENX

Method Summary

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

ZONLY

public static final MultipoleType.MultipoleFrameDefinition ZONLY

ZTHENX

public static final MultipoleType.MultipoleFrameDefinition ZTHENX

BISECTOR

public static final MultipoleType.MultipoleFrameDefinition BISECTOR

ZTHENBISECTOR

public static final MultipoleType.MultipoleFrameDefinition ZTHENBISECTOR

THREEFOLD

public static final MultipoleType.MultipoleFrameDefinition THREEFOLD

Method Details

values

public static MultipoleType.MultipoleFrameDefinition[] 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 MultipoleType.MultipoleFrameDefinition 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