ucar.nc2.constants

Enum AxisType

java.lang.Object

java.lang.Enum<AxisType>

ucar.nc2.constants.AxisType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AxisType>

public enum AxisType
extends java.lang.Enum<AxisType>

Type-safe enumeration of netCDF Coordinate Axis types. These are used for tagging georeferencing axes.

Author:

john caron

Enum Constant Summary

Enum Constants

Enum Constant and Description
Ensemble represents the ensemble coordinate
GeoX represents a x coordinate
GeoY represents a y coordinate
GeoZ represents a z coordinate
Height represents a vertical height coordinate
Lat represents a latitude coordinate
Lon represents a longitude coordinate
Pressure represents a vertical pressure coordinate
RadialAzimuth represents a radial azimuth coordinate
RadialDistance represents a radial distance coordinate
RadialElevation represents a radial elevation coordinate
RunTime represents the runTime coordinate
Time represents the time coordinate

Method Summary

Methods

Modifier and Type	Method and Description
int	axisOrder() axis ordering: runTime - ensemble - time - z - y - x or elev - azimuth - distance
static AxisType	getType(java.lang.String name) Find the AxisType that matches this name.
static AxisType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AxisType[]	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

RunTime

public static final AxisType RunTime

represents the runTime coordinate

Ensemble

public static final AxisType Ensemble

represents the ensemble coordinate

Time

public static final AxisType Time

represents the time coordinate

GeoX

public static final AxisType GeoX

represents a x coordinate

GeoY

public static final AxisType GeoY

represents a y coordinate

GeoZ

public static final AxisType GeoZ

represents a z coordinate

Lat

public static final AxisType Lat

represents a latitude coordinate

Lon

public static final AxisType Lon

represents a longitude coordinate

Height

public static final AxisType Height

represents a vertical height coordinate

Pressure

public static final AxisType Pressure

represents a vertical pressure coordinate

RadialAzimuth

public static final AxisType RadialAzimuth

represents a radial azimuth coordinate

RadialDistance

public static final AxisType RadialDistance

represents a radial distance coordinate

RadialElevation

public static final AxisType RadialElevation

represents a radial elevation coordinate

Method Detail

values

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

Returns:

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

valueOf

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

getType

public static AxisType getType(java.lang.String name)

Find the AxisType that matches this name.

Parameters:

name - match this name

Returns:

AxisType or null if no match.

axisOrder

public int axisOrder()

axis ordering: runTime - ensemble - time - z - y - x or elev - azimuth - distance

Returns:

order