AxisType (NetCDF-Java CDM Public API v5.4.2)

java.lang.Object
- java.lang.Enum<AxisType>
- - ucar.nc2.constants.AxisType

All Implemented Interfaces:

Serializable, Comparable<AxisType>
```
public enum AxisType
extends Enum<AxisType>
```
Enumeration of Coordinate Axis types. These are used for tagging georeferencing axes. Do not change the ordering of these enums, as they are used in protobuf messages, only add new ones onto the end. TODO: remove dependency on ordering.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Dimension`
`Ensemble`
`GeoX`
`GeoY`
`GeoZ`
`Height`
`Lat`
`Lon`
`Pressure`
`RadialAzimuth`
`RadialDistance`
`RadialElevation`
`RunTime`
`SimpleGeometryID`
`SimpleGeometryX`
`SimpleGeometryY`
`SimpleGeometryZ`
`Spectral`
`Time`
`TimeOffset`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`axisOrder()` axis ordering: runTime - ensemble - time - z - y - x or elev - azimuth - distance
`String`	`getCFAxisName()`
`static AxisType`	`getType(String name)` Find the AxisType that matches this name.
`boolean`	`isHoriz()`
`boolean`	`isTime()`
`boolean`	`isVert()`
`static AxisType`	`valueOf(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
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Dimension
```
public static final AxisType Dimension
```

Ensemble
```
public static final AxisType Ensemble
```

GeoX
```
public static final AxisType GeoX
```

GeoY
```
public static final AxisType GeoY
```

GeoZ
```
public static final AxisType GeoZ
```

Height
```
public static final AxisType Height
```

Lat
```
public static final AxisType Lat
```

Lon
```
public static final AxisType Lon
```

Pressure
```
public static final AxisType Pressure
```

RadialAzimuth

public static final AxisType RadialAzimuth

RadialDistance

public static final AxisType RadialDistance

RadialElevation

public static final AxisType RadialElevation

RunTime
```
public static final AxisType RunTime
```

SimpleGeometryID

public static final AxisType SimpleGeometryID

SimpleGeometryX

public static final AxisType SimpleGeometryX

SimpleGeometryY

public static final AxisType SimpleGeometryY

SimpleGeometryZ

public static final AxisType SimpleGeometryZ

Spectral
```
public static final AxisType Spectral
```

Time
```
public static final AxisType Time
```

TimeOffset

public static final AxisType TimeOffset

Method Detail
- axisOrder
```
public int axisOrder()
```
  axis ordering: runTime - ensemble - time - z - y - x or elev - azimuth - distance
  
  Returns:
  
  order
- getCFAxisName
```
public String getCFAxisName()
```
- getType
```
public static AxisType getType(String name)
```
  Find the AxisType that matches this name.
  
  Parameters:
  
  name - match this name
  
  Returns:
  
  AxisType or null if no match.
- isHoriz
```
public boolean isHoriz()
```
- isTime
```
public boolean isTime()
```
- isVert
```
public boolean isVert()
```
- valueOf
```
public static AxisType 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
- 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

Enum AxisType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Dimension

Ensemble

GeoX

GeoY

GeoZ

Height

Lat

Lon

Pressure

RadialAzimuth

RadialDistance

RadialElevation

RunTime

SimpleGeometryID

SimpleGeometryX

SimpleGeometryY

SimpleGeometryZ

Spectral

Time

TimeOffset

Method Detail

axisOrder

getCFAxisName

getType

isHoriz

isTime

isVert

valueOf

values