Package ffx.crystal

Enum Class ASULimit

java.lang.Object

java.lang.Enum<ASULimit>

ffx.crystal.ASULimit

All Implemented Interfaces:

Serializable, Comparable<ASULimit>, Constable

public enum ASULimit
extends Enum<ASULimit>

Enumeration of the different asymmetric unit limit operators.

Since:

1.0

Author:

Michael J. Schnieders

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
LT	Less than operator.
LTE	Less than or equal to operator.

Method Summary

Modifier and Type	Method	Description
boolean	check(double limit, double x)	Check the given point is within the asymmetric unit limit.
static ASULimit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ASULimit[]	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

LT

public static final ASULimit LT

Less than operator.

LTE

public static final ASULimit LTE

Less than or equal to operator.

Method Details

values

public static ASULimit[] 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 ASULimit 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

check

public boolean check(double limit,
 double x)

Check the given point is within the asymmetric unit limit.

Parameters:

limit - a double.

x - a double.

Returns:

True if the point is within the real space asymmetric unit, false otherwise.