VerticalCrs (Environmental Data Abstraction Library 1.5.2 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

VerticalCrsImpl
```
public interface VerticalCrs
extends Serializable
```
A vertical coordinate reference system.

We don't use GeoAPI's VerticalCRS class here as we need to incorporate pressure and dimensionless coordinates.

Author:

Guy Griffiths, Jon Blower

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getUnits()`	Returns the units for the values in this `VerticalCrs`
`int`	`hashCode()`
`boolean`	`isDimensionless()`	Return true if this is a dimensionless (e.g.
`boolean`	`isPositiveUpwards()`	Indicates whether coordinate values increase upward or downward.
`boolean`	`isPressure()`	Return true if this axis has units of pressure.

- Method Detail
  - getUnits
```
String getUnits()
```
    Returns the units for the values in this VerticalCrs
    TODO This may need replacing with a stronger type
  - isPressure
```
boolean isPressure()
```
    Return true if this axis has units of pressure. If this is true then the positive direction must be DOWN.
  - isDimensionless
```
boolean isDimensionless()
```
    Return true if this is a dimensionless (e.g. sigma or terrain-following) coordinate system. If this is true then the units are irrelevant, and isPressure() will return false.
    
    Future APIs will need to allow conversions between dimensionless and dimensional coordinates, which will require more information. (The conversion can be performed using existing routines, e.g. in Java-NetCDF.) However, the current purpose of EDAL is not to perform the conversion but to provide client code with enough information to decide what to do.
    
    See Also:
    
    CF conventions
  - isPositiveUpwards
```
boolean isPositiveUpwards()
```
    Indicates whether coordinate values increase upward or downward.
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object