Package org.jscience.geography.coordinates

Class Altitude

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<javax.measure.Measurable<javax.measure.quantity.Length>>, javax.measure.Measurable<javax.measure.quantity.Length>, javolution.lang.Immutable, javolution.lang.Realtime, javolution.lang.ValueType, javolution.xml.XMLSerializable, org.opengis.spatialschema.geometry.DirectPosition, org.opengis.spatialschema.geometry.geometry.Position, org.opengis.util.Cloneable
    public final class Altitude
extends Coordinates<VerticalCRS<?>>
implements javax.measure.Measurable<javax.measure.quantity.Length>
    This class represents the Mean-Sea-Level vertical altitude (MSL).

    Note: The current implementation approximates the MSL altitude to the WGS-86 Ellipsoid Height. Future implementations will use lookup tables in order to correct for regional discrepencies.

    Version:
    3.0, February 26, 2006
    Author:
    Jean-Marie Dautelle
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static VerticalCRS<Altitude> CRS
      Holds the coordinate reference system for all instances of this class.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(javax.measure.Measurable<javax.measure.quantity.Length> measure)  
      Altitude copy()
      Returns a copy of these coordinates allocated by the calling thread (possibly on the stack).
      double doubleValue​(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
      Returns the value of this measurable stated in the specified unit as a double.
      VerticalCRS<?> getCoordinateReferenceSystem()
      Returns the reference system for this coordinates.
      int getDimension()
      OpenGIS® - The length of coordinate sequence (the number of entries).
      double getOrdinate​(int dimension)
      OpenGIS® - Returns the ordinate at the specified dimension.
      long longValue​(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
      Returns the estimated integral value of this measurable stated in the specified unit as a long.
      static Altitude valueOf​(double value, javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
      Returns the vertical position corresponding to the specified coordinates.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • CRS

        public static final VerticalCRS<Altitude> CRS
        Holds the coordinate reference system for all instances of this class.

    • Method Detail

      • valueOf

        public static Altitude valueOf​(double value,
                               javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
        Returns the vertical position corresponding to the specified coordinates.
        Parameters:
        value - the mean sea level altitude stated in the specified unit.
        unit - the length unit in which the altitude is stated.
        Returns:
        the corresponding vertical position.

      • getOrdinate

        public double getOrdinate​(int dimension)
                   throws java.lang.IndexOutOfBoundsException
        Description copied from class: Coordinates
        OpenGIS® - Returns the ordinate at the specified dimension.
        Specified by:
        getOrdinate in interface org.opengis.spatialschema.geometry.DirectPosition
        Specified by:
        getOrdinate in class Coordinates<VerticalCRS<?>>
        Parameters:
        dimension - The dimension in the range 0 to dimension-1.
        Returns:
        The coordinate at the specified dimension.
        Throws:
        java.lang.IndexOutOfBoundsException - if the specified dimension is out of bounds.

      • doubleValue

        public final double doubleValue​(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
        Description copied from interface: javax.measure.Measurable
        Returns the value of this measurable stated in the specified unit as a double. If the measurable has too great a magnitude to be represented as a double, it will be converted to Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY as appropriate.
        Specified by:
        doubleValue in interface javax.measure.Measurable<javax.measure.quantity.Length>
        Parameters:
        unit - the unit in which this measurable value is stated.
        Returns:
        the numeric value after conversion to type double.

      • longValue

        public final long longValue​(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
        Description copied from interface: javax.measure.Measurable
        Returns the estimated integral value of this measurable stated in the specified unit as a long.

        Note: This method differs from the Number.longValue() in the sense that the closest integer value is returned and an ArithmeticException is raised instead of a bit truncation in case of overflow (safety critical).

        Specified by:
        longValue in interface javax.measure.Measurable<javax.measure.quantity.Length>
        Parameters:
        unit - the unit in which the measurable value is stated.
        Returns:
        the numeric value after conversion to type long.

      • compareTo

        public int compareTo​(javax.measure.Measurable<javax.measure.quantity.Length> measure)
        Specified by:
        compareTo in interface java.lang.Comparable<javax.measure.Measurable<javax.measure.quantity.Length>>

      • copy

        public Altitude copy()
        Description copied from class: Coordinates
        Returns a copy of these coordinates allocated by the calling thread (possibly on the stack).
        Specified by:
        copy in interface javolution.lang.ValueType
        Specified by:
        copy in class Coordinates<VerticalCRS<?>>
        Returns:
        an identical and independant copy of these coordinates .