org.deegree.model.csct.cs
Class VerticalCoordinateSystem

java.lang.Object
  org.deegree.model.csct.cs.Info
      org.deegree.model.csct.cs.CoordinateSystem
          org.deegree.model.csct.cs.VerticalCoordinateSystem

All Implemented Interfaces:

Serializable, Dimensioned

public class VerticalCoordinateSystem
extends CoordinateSystem

A one-dimensional coordinate system suitable for vertical measurements.

Version:

1.00, $Revision: 6259 $, $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux, last edited by: $Author: bezema $

See Also:

"org.opengis.cs.CS_VerticalCoordinateSystem", Serialized Form

Field Summary

static VerticalCoordinateSystem

ELLIPSOIDAL Default vertical coordinate system using ellipsoidal datum.

Fields inherited from class org.deegree.model.csct.cs.Info

pool

Constructor Summary

VerticalCoordinateSystem(Map properties, VerticalDatum datum, Unit unit, AxisInfo axis)
Creates a vertical coordinate system from a datum and linear units.

VerticalCoordinateSystem(String name, VerticalDatum datum)
Creates a vertical coordinate system from a datum.

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

Method Summary

(package private) String	addString(StringBuffer buffer) Fill the part inside "[...]".
boolean	equivalents(CoordinateSystem cs) Returns true if this coordinate system is equivalents to the specified coordinate system.
AxisInfo	getAxis(int dimension) Gets axis details for vertical dimension within coordinate system.
(package private) Datum	getDatum() Override CoordinateSystem.getDatum().
int	getDimension() Returns the dimension of this coordinate system, which is 1.
Unit	getUnits(int dimension) Gets units for dimension within coordinate system.
VerticalDatum	getVerticalDatum() Gets the vertical datum, which indicates the measurement method.

Methods inherited from class org.deegree.model.csct.cs.CoordinateSystem

checkAxis, equals, getDefaultEnvelope, getUnits

Methods inherited from class org.deegree.model.csct.cs.Info

addString, addUnit, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, getAbbreviation, getAlias, getAuthority, getAuthorityCode, getName, getRemarks, hashCode, readResolve, toString

Methods inherited from class java.lang.Object

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

Field Detail

ELLIPSOIDAL

public static final VerticalCoordinateSystem ELLIPSOIDAL

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(String name,
                                VerticalDatum datum)

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(String name,
                                VerticalDatum datum,
                                Unit unit,
                                AxisInfo axis)

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.

VerticalCoordinateSystem

VerticalCoordinateSystem(Map properties,
                         VerticalDatum datum,
                         Unit unit,
                         AxisInfo axis)

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

Parameters:

properties - The set of properties (see Info).

datum - Datum to use for new coordinate system.

unit - Units to use for new coordinate system.

axis - Axis to use for new coordinate system.

Method Detail

getDimension

public final int getDimension()

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

Specified by:

getDimension in interface Dimensioned

Specified by:

getDimension in class CoordinateSystem

Returns:

the dimension of this coordinate system, which is 1.

See Also:

"org.opengis.cs.CS_VerticalCoordinateSystem#getDimension()"

getDatum

final Datum getDatum()

Override CoordinateSystem.getDatum().

Overrides:

getDatum in class CoordinateSystem

Returns:

the datum.

getVerticalDatum

public VerticalDatum getVerticalDatum()

Gets the vertical datum, which indicates the measurement method.

Returns:

the vertical datum, which indicates the measurement method.

See Also:

"org.opengis.cs.CS_VerticalCoordinateSystem#getVerticalDatum()"

getAxis

public AxisInfo getAxis(int dimension)

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

Specified by:

getAxis in class CoordinateSystem

Parameters:

dimension - Zero based index of axis.

Returns:

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

See Also:

"org.opengis.cs.CS_VerticalCoordinateSystem#getAxis(int)"

getUnits

public Unit getUnits(int dimension)

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

Specified by:

getUnits in class CoordinateSystem

Parameters:

dimension - Must be 0.

Returns:

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

See Also:

"org.opengis.cs.CS_VerticalCoordinateSystem#getUnits(int)", "org.opengis.cs.CS_VerticalCoordinateSystem#getVerticalUnit()"

equivalents

public boolean equivalents(CoordinateSystem cs)

Returns true if this coordinate system is equivalents to the specified coordinate system. Two coordinate systems are considered equivalent if the CoordinateTransformation from this to cs would be the identity transform. The default implementation compare datum, units and axis, but ignore name, alias and other meta-data informations.

Overrides:

equivalents in class CoordinateSystem

Parameters:

cs - The coordinate system (may be null).

Returns:

true if both coordinate systems are equivalent.

addString

String addString(StringBuffer buffer)

Fill the part inside "[...]". Used for formatting Well Know Text (WKT).

Parameters:

buffer -

Returns: