org.deegree.cs.coordinatesystems
Class CompoundCRS

java.lang.Object
  org.deegree.cs.CRSIdentifiable
      org.deegree.cs.coordinatesystems.CoordinateSystem
          org.deegree.cs.coordinatesystems.CompoundCRS

public class CompoundCRS
extends CoordinateSystem

A CompoundCRS is a GeographicCRS with a third axis (the height axis) attached. This axis denotes a vertical axis, which defines a unit for a given height above or below the datums surface.

Version:

$Revision: 23539 $, $Date: 2010-04-12 13:24:29 +0200 (Mo, 12. Apr 2010) $

Author:

Rutger Bezema, last edited by: $Author: rbezema $

Nested Class Summary

Nested classes/interfaces inherited from class org.deegree.cs.coordinatesystems.CoordinateSystem

CoordinateSystem.CRSType

Constructor Summary

CompoundCRS(Axis heightAxis, CoordinateSystem underlyingCRS, double defaultHeight, CRSIdentifiable identity)

Method Summary

Axis[]	getAxis()
double	getDefaultHeight()
int	getDimension()
Axis	getHeightAxis()
Unit	getHeightUnits()
CoordinateSystem.CRSType	getType()
CoordinateSystem	getUnderlyingCRS()

Methods inherited from class org.deegree.cs.coordinatesystems.CoordinateSystem

convertToAxis, equals, getDatum, getDirectTransformation, getEasting, getGeodeticDatum, getNorthing, getTransformations, getTypeName, getUnits, getValidDomain, hasDirectTransformation, hashCode, toString

Methods inherited from class org.deegree.cs.CRSIdentifiable

addAreaOfUse, addName, checkForNullObject, checkForNullObject, checkForNullObject, getAreaOfUse, getAreaOfUseBBox, getAreasOfUse, getCode, getCodeAndName, getCodes, getDescription, getDescriptions, getName, getNames, getOrignalCodeStrings, getVersion, getVersions, hasCode, hasId, hasIdOrName, setDefaultAreaOfUse, setDefaultDescription, setDefaultId, setDefaultName, setDefaultVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundCRS

public CompoundCRS(Axis heightAxis,
                   CoordinateSystem underlyingCRS,
                   double defaultHeight,
                   CRSIdentifiable identity)
            throws java.lang.IllegalArgumentException

Parameters:

heightAxis - defining the name and the units of the 'vertical' axis

underlyingCRS - the crs to which the height axis is added, only geographic, geocentric or projected crs are valid.

defaultHeight - of the any coordinate which does not have a height-axis-value.

identity - containing the identifiable values.

Throws:

java.lang.IllegalArgumentException - if the underlying crs is not of type geographic, geocentric or projected or one of the other values is null.

Method Detail

getDimension

public int getDimension()

Specified by:

getDimension in class CoordinateSystem

Returns:

the dimension of this CRS.

getType

public final CoordinateSystem.CRSType getType()

Specified by:

getType in class CoordinateSystem

Returns:

one of the *_CRS types defined in this class.

getHeightAxis

public final Axis getHeightAxis()

Returns:

the heightAxis.

getHeightUnits

public final Unit getHeightUnits()

Returns:

the units of the heightAxis.

getAxis

public Axis[] getAxis()

Overrides:

getAxis in class CoordinateSystem

Returns:

the geographic Axis and the heightAxis as the third component.

getUnderlyingCRS

public final CoordinateSystem getUnderlyingCRS()

Returns:

the underlyingCRS.

getDefaultHeight

public double getDefaultHeight()

Returns:

the defaultHeight or 0 if it was not set.