org.geotools.cs
Class VerticalCoordinateSystem

java.lang.Object
  org.geotools.cs.Info
      org.geotools.cs.CoordinateSystem
          org.geotools.cs.VerticalCoordinateSystem

All Implemented Interfaces:

org.opengis.referencing.crs.CoordinateReferenceSystem, Dimensioned, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem, java.io.Serializable

Deprecated. Replaced by DefaultVerticalCRS.

public class VerticalCoordinateSystem

extends CoordinateSystem

A one-dimensional coordinate system suitable for vertical measurements.

Version:

$Id: VerticalCoordinateSystem.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux

See Also:

CS_VerticalCoordinateSystem, Serialized Form

Field Summary

static VerticalCoordinateSystem

ELLIPSOIDAL Deprecated. Default vertical coordinate system using ellipsoidal datum.

Fields inherited from interface org.opengis.referencing.ReferenceSystem

SCOPE_KEY, VALID_AREA_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

VerticalCoordinateSystem(java.lang.CharSequence name, VerticalDatum datum)
Deprecated. Creates a vertical coordinate system from a datum.

VerticalCoordinateSystem(java.lang.CharSequence name, VerticalDatum datum, Unit unit, AxisInfo axis)
Deprecated. Creates a vertical coordinate system from a datum and linear units.

Method Summary

boolean	equals(Info object, boolean compareNames) Deprecated. Compare this coordinate system with the specified object for equality.
AxisInfo	getAxis(int dimension) Deprecated. Gets axis details for vertical dimension within coordinate system.
int	getDimension() Deprecated. Returns the dimension of this coordinate system, which is 1.
Unit	getUnits(int dimension) Deprecated. Replaced by DefaultCoordinateSystemAxis.getUnit().
VerticalDatum	getVerticalDatum() Deprecated. Replaced by AbstractSingleCRS.getDatum().
int	hashCode() Deprecated. Returns a hash value for this coordinate system.

Methods inherited from class org.geotools.cs.CoordinateSystem

fromGeoAPI, getCoordinateSystem, getDatum, getDefaultEnvelope, getScope, getValidArea

Methods inherited from class org.geotools.cs.Info

ensureNonNull, equals, getAbbreviation, getAlias, getAlias, getAuthority, getAuthorityCode, getIdentifiers, getName, getRemarks, toString, toWKT

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

ELLIPSOIDAL

public static final VerticalCoordinateSystem ELLIPSOIDAL

Deprecated.

Default vertical coordinate system using ellipsoidal datum. Ellipsoidal heights are measured along the normal to the ellipsoid used in the definition of horizontal datum.

Constructor Detail

VerticalCoordinateSystem

public VerticalCoordinateSystem(java.lang.CharSequence name,
                                VerticalDatum datum)

Deprecated.

Creates a vertical coordinate system from a datum. Units will be metres and values will be increasing upward.

Parameters:

name - Name to give new object.

datum - Datum to use for new coordinate system.

VerticalCoordinateSystem

public VerticalCoordinateSystem(java.lang.CharSequence name,
                                VerticalDatum datum,
                                Unit unit,
                                AxisInfo axis)

Deprecated.

Creates a vertical coordinate system from a datum and linear units.

Parameters:

name - Name to give new object.

datum - Datum to use for new coordinate system.

unit - Units to use for new coordinate system.

axis - Axis to use for new coordinate system.

See Also:

CS_CoordinateSystemFactory.createVerticalCoordinateSystem(java.lang.String, org.opengis.cs.CS_VerticalDatum, org.opengis.cs.CS_LinearUnit, org.opengis.cs.CS_AxisInfo)

Method Detail

getDimension

public final int getDimension()

Deprecated.

Returns the dimension of this coordinate system, which is 1.

Specified by:

getDimension in interface Dimensioned

Specified by:

getDimension in class CoordinateSystem

See Also:

CS_CoordinateSystem.getDimension()

getVerticalDatum

public VerticalDatum getVerticalDatum()

Deprecated. Replaced by AbstractSingleCRS.getDatum().

Gets the vertical datum, which indicates the measurement method.

See Also:

CS_VerticalCoordinateSystem.getVerticalDatum()

getAxis

public AxisInfo getAxis(int dimension)

Deprecated.

Gets axis details for vertical dimension within coordinate system. A vertical coordinate system has only one axis, always at index 0.

Specified by:

getAxis in class CoordinateSystem

Parameters:

dimension - Zero based index of axis.

See Also:

CS_CoordinateSystem.getAxis(int)

getUnits

public Unit getUnits(int dimension)

Deprecated. Replaced by DefaultCoordinateSystemAxis.getUnit().

Gets units for dimension within coordinate system. A vertical coordinate system has only one unit, always at index 0.

Specified by:

getUnits in class CoordinateSystem

Parameters:

dimension - Must be 0.

See Also:

CS_CoordinateSystem.getUnits(int), CS_VerticalCoordinateSystem.getVerticalUnit()

equals

public boolean equals(Info object,
                      boolean compareNames)

Deprecated.

Compare this coordinate system with the specified object for equality.

Overrides:

equals in class Info

Parameters:

object - The object to compare to this.

compareNames - true to comparare the name, alias, authority code, etc. as well, or false to compare only properties relevant to transformations.

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this coordinate system. Name, alias, authority code and the like are not taken in account. In other words, two coordinate systems will return the same hash value if they are equal in the sense of equals(Info, false).

Overrides:

hashCode in class Info

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.