Package ucar.nc2.grid

Enum GridAxisDependenceType

java.lang.Object

java.lang.Enum<GridAxisDependenceType>

ucar.nc2.grid.GridAxisDependenceType

All Implemented Interfaces:

Serializable, Comparable<GridAxisDependenceType>

public enum GridAxisDependenceType
extends Enum<GridAxisDependenceType>

The way that the Axis depends on other axes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
dependent	Auxilary coordinate, eg reftime(time) or time_bounds(time).
dimension	Eg swath(scan, scanAcross).
fmrcReg	Eg time(reftime, hourOfDay).
independent	Has its own dimension, so is a coordinate variable, eg x(x).
scalar	A scalar doesnt involve indices.
twoD	A coordinate needing two dimensions, eg lat(x,y).

Method Summary

Modifier and Type	Method	Description
static GridAxisDependenceType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GridAxisDependenceType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

independent

public static final GridAxisDependenceType independent

Has its own dimension, so is a coordinate variable, eg x(x).

dependent

public static final GridAxisDependenceType dependent

Auxilary coordinate, eg reftime(time) or time_bounds(time).

scalar

public static final GridAxisDependenceType scalar

A scalar doesnt involve indices. Eg the reference time is often a scalar.

twoD

public static final GridAxisDependenceType twoD

A coordinate needing two dimensions, eg lat(x,y). Not currently used.

fmrcReg

public static final GridAxisDependenceType fmrcReg

Eg time(reftime, hourOfDay). Not currently used.

dimension

public static final GridAxisDependenceType dimension

Eg swath(scan, scanAcross). Not currently used.

Method Detail

values

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

Returns:

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

valueOf

public static GridAxisDependenceType 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