ucar.nc2.grid

Enum GridAxis.Spacing

java.lang.Object

java.lang.Enum<GridAxis.Spacing>

ucar.nc2.grid.GridAxis.Spacing

All Implemented Interfaces:

Serializable, Comparable<GridAxis.Spacing>

Enclosing class:

GridAxis

public static enum GridAxis.Spacing
extends Enum<GridAxis.Spacing>

The spacing of the coordinate values, used for 1D axes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
contiguousInterval Irregular contiguous intervals values[npts+1]; values are the edges, midpoints halfway between edges.
discontiguousInterval Irregular discontiguous intervals values[2*npts]; values are the edges: low0, high0, low1, high1, ...
irregularPoint Irregular spaced points values[npts]; edges halfway between coords.
regularInterval Regular contiguous intervals (start, end, npts); start and end are edges, midpoints halfway between edges, resol = (start - end) / npts.
regularPoint Regularly spaced points (start, end, npts); start and end are midpoints, edges halfway between midpoints, resol = (start - end) / (npts-1)

Method Summary

Modifier and Type	Method and Description
boolean	isInterval() If the coordinate values are intervals.
boolean	isRegular() If the spacing is regular.
static GridAxis.Spacing	valueOf(String name) Returns the enum constant of this type with the specified name.
static GridAxis.Spacing[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

regularPoint

public static final GridAxis.Spacing regularPoint

Regularly spaced points (start, end, npts); start and end are midpoints, edges halfway between midpoints, resol = (start - end) / (npts-1)

irregularPoint

public static final GridAxis.Spacing irregularPoint

Irregular spaced points values[npts]; edges halfway between coords.

regularInterval

public static final GridAxis.Spacing regularInterval

Regular contiguous intervals (start, end, npts); start and end are edges, midpoints halfway between edges, resol = (start - end) / npts.

contiguousInterval

public static final GridAxis.Spacing contiguousInterval

Irregular contiguous intervals values[npts+1]; values are the edges, midpoints halfway between edges.

discontiguousInterval

public static final GridAxis.Spacing discontiguousInterval

Irregular discontiguous intervals values[2*npts]; values are the edges: low0, high0, low1, high1, ... Note that monotonicity is not guaranteed, and is ambiguous.

Method Detail

values

public static GridAxis.Spacing[] 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 (GridAxis.Spacing c : GridAxis.Spacing.values())
    System.out.println(c);

Returns:

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

valueOf

public static GridAxis.Spacing valueOf(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:

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

NullPointerException - if the argument is null

isRegular

public boolean isRegular()

If the spacing is regular.

isInterval

public boolean isInterval()

If the coordinate values are intervals.