geomss.geom

Enum GridSpacing.GridType

java.lang.Object

java.lang.Enum<GridSpacing.GridType>

geomss.geom.GridSpacing.GridType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GridSpacing.GridType>

Enclosing class:

GridSpacing

public static enum GridSpacing.GridType
extends java.lang.Enum<GridSpacing.GridType>

An enumeration of the available grid spacing types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACOS
COS
LINEAR
ONEMSQRT
SQR
SQRT

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Double>	spacing(int n) Return a list of "n" values between 0 and 1 (inclusive) using this grid spacing type.
java.lang.String	toString()
static GridSpacing.GridType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GridSpacing.GridType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LINEAR

public static final GridSpacing.GridType LINEAR

SQR

public static final GridSpacing.GridType SQR

ONEMSQRT

public static final GridSpacing.GridType ONEMSQRT

ACOS

public static final GridSpacing.GridType ACOS

COS

public static final GridSpacing.GridType COS

SQRT

public static final GridSpacing.GridType SQRT

Method Detail

values

public static GridSpacing.GridType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GridSpacing.GridType c : GridSpacing.GridType.values())
    System.out.println(c);

Returns:

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

valueOf

public static GridSpacing.GridType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<GridSpacing.GridType>

spacing

public java.util.List<java.lang.Double> spacing(int n)

Return a list of "n" values between 0 and 1 (inclusive) using this grid spacing type.

Parameters:

n - The number of points to include in the spacing.

Returns:

A list of points, of size n, with the spacing of this GridType.