org.geotools.referencing.cs
Class DefaultVerticalCS

java.lang.Object
  extended byorg.geotools.referencing.wkt.Formattable
      extended byorg.geotools.referencing.AbstractIdentifiedObject
          extended byorg.geotools.referencing.cs.AbstractCS
              extended byorg.geotools.referencing.cs.DefaultVerticalCS
All Implemented Interfaces:
org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.IdentifiedObject, java.io.Serializable, org.opengis.referencing.cs.VerticalCS

public class DefaultVerticalCS
extends AbstractCS
implements org.opengis.referencing.cs.VerticalCS

A one-dimensional coordinate system used to record the heights (or depths) of points. Such a coordinate system is usually dependent on the Earth's gravity field, perhaps loosely as when atmospheric pressure is the basis for the vertical coordinate system axis. An exact definition is deliberately not provided as the complexities of the subject fall outside the scope of this specification. A shall have one axis.

Used with CRS type(s)
Vertical, Engineering

Since:
2.1
Version:
$Id: DefaultVerticalCS.java 17672 2006-01-19 00:25:55Z desruisseaux $
Author:
Martin Desruisseaux
See Also:
Serialized Form

Field Summary
static DefaultVerticalCS DEPTH
          A one-dimensional vertical CS with depth axis in metres.
static DefaultVerticalCS ELLIPSOIDAL_HEIGHT
          A one-dimensional vertical CS with ellipsoidal height axis in metres.
static DefaultVerticalCS GRAVITY_RELATED
          A one-dimensional vertical CS with gravity-related height axis in metres.
 
Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR
 
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
 
Constructor Summary
DefaultVerticalCS(java.util.Map properties, org.opengis.referencing.cs.CoordinateSystemAxis axis)
          Constructs a coordinate system from a set of properties.
DefaultVerticalCS(java.lang.String name, org.opengis.referencing.cs.CoordinateSystemAxis axis)
          Constructs a coordinate system from a name.
DefaultVerticalCS(org.opengis.referencing.cs.VerticalCS cs)
          Constructs a new coordinate system with the same values than the specified one.
 
Method Summary
 Measure distance(double[] coord1, double[] coord2)
          Computes the distance between two points.
protected  boolean isCompatibleDirection(org.opengis.referencing.cs.AxisDirection direction)
          Returns if the specified axis direction is allowed for this coordinate system.
 
Methods inherited from class org.geotools.referencing.cs.AbstractCS
equals, formatWKT, getAxis, getDimension, hashCode, isCompatibleUnit, standard, swapAndScaleAxis
 
Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches
 
Methods inherited from class org.geotools.referencing.wkt.Formattable
toString, toWKT, toWKT, toWKT
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.opengis.referencing.cs.CoordinateSystem
getAxis, getDimension
 
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
 

Field Detail

ELLIPSOIDAL_HEIGHT

public static DefaultVerticalCS ELLIPSOIDAL_HEIGHT
A one-dimensional vertical CS with ellipsoidal height axis in metres.


GRAVITY_RELATED

public static DefaultVerticalCS GRAVITY_RELATED
A one-dimensional vertical CS with gravity-related height axis in metres.


DEPTH

public static DefaultVerticalCS DEPTH
A one-dimensional vertical CS with depth axis in metres.

Constructor Detail

DefaultVerticalCS

public DefaultVerticalCS(org.opengis.referencing.cs.VerticalCS cs)
Constructs a new coordinate system with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Since:
2.2

DefaultVerticalCS

public DefaultVerticalCS(java.lang.String name,
                         org.opengis.referencing.cs.CoordinateSystemAxis axis)
Constructs a coordinate system from a name.

Parameters:
name - The coordinate system name.
axis - The axis.

DefaultVerticalCS

public DefaultVerticalCS(java.util.Map properties,
                         org.opengis.referencing.cs.CoordinateSystemAxis axis)
Constructs a coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:
properties - Set of properties. Should contains at least "name".
axis - The axis.
Method Detail

isCompatibleDirection

protected boolean isCompatibleDirection(org.opengis.referencing.cs.AxisDirection direction)
Returns if the specified axis direction is allowed for this coordinate system. The default implementation accepts only vertical directions (i.e. UP and DOWN).

Overrides:
isCompatibleDirection in class AbstractCS

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Computes the distance between two points.

Overrides:
distance in class AbstractCS
Parameters:
coord1 - Coordinates of the first point.
coord2 - Coordinates of the second point.
Returns:
The distance between and .
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if a coordinate doesn't have the expected dimension.


Copyright © GeoTools. All Rights Reserved.