JScience v4.3

org.jscience.geography.coordinates
Class XYZ

java.lang.Object
  extended by org.jscience.geography.coordinates.Coordinates<GeocentricCRS<XYZ>>
      extended by org.jscience.geography.coordinates.XYZ
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, javolution.lang.Immutable, javolution.lang.Realtime, javolution.lang.ValueType, javolution.xml.XMLSerializable, org.opengis.spatialschema.geometry.DirectPosition, org.opengis.spatialschema.geometry.geometry.Position

public final class XYZ
extends Coordinates<GeocentricCRS<XYZ>>

This class represents the geocentric Earth-Centered, Earth-Fixed (ECEF) cartesian coordinates used in GPS/GLONASS.

Version:
3.0, February 18, 2006
Author:
Paul D. Anderson
See Also:
Serialized Form

Field Summary
static GeocentricCRS<XYZ> CRS
          Holds the coordinate reference system for all instances of this class.
 
Method Summary
 XYZ copy()
          Returns a copy of these coordinates allocated by the calling thread (possibly on the stack).
 GeocentricCRS<XYZ> 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.
 Float64Vector toVector(Unit<Length> unit)
          Returns the x/y/z coordinates value as a 3-dimensional vector.
static XYZ valueOf(double x, double y, double z, Unit<Length> unit)
          Returns the spatial position corresponding to the specified coordinates.
static XYZ valueOf(Float64Vector vector, Unit<Length> unit)
          Returns the spatial position corresponding to the specified 3-dimensional vector.
 double xValue(Unit<Length> unit)
          Returns the x coordinate value as double
 double yValue(Unit<Length> unit)
          Returns the y coordinate value as double
 double zValue(Unit<Length> unit)
          Returns the z coordinate value as double
 
Methods inherited from class org.jscience.geography.coordinates.Coordinates
clone, getCoordinates, getPosition, setOrdinate, toString, toText
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CRS

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

Method Detail

valueOf

public static XYZ valueOf(double x,
                          double y,
                          double z,
                          Unit<Length> unit)
Returns the spatial position corresponding to the specified coordinates.

Parameters:
x - the x value stated in the specified unit.
y - the y value stated in the specified unit.
z - the z value stated in the specified unit.
unit - the length unit in which the coordinates are stated.
Returns:
the corresponding 3D position.

valueOf

public static XYZ valueOf(Float64Vector vector,
                          Unit<Length> unit)
Returns the spatial position corresponding to the specified 3-dimensional vector.

Parameters:
vector - the 3-dimensional vector holding the x/y/z coordinates.
unit - the length unit in which the coordinates are stated.
Returns:
the corresponding 3D position.

xValue

public double xValue(Unit<Length> unit)
Returns the x coordinate value as double

Parameters:
unit - the length unit of the x coordinate value to return.
Returns:
the x coordinate stated in the specified unit.

yValue

public double yValue(Unit<Length> unit)
Returns the y coordinate value as double

Parameters:
unit - the length unit of the x coordinate value to return.
Returns:
the z coordinate stated in the specified unit.

zValue

public double zValue(Unit<Length> unit)
Returns the z coordinate value as double

Parameters:
unit - the length unit of the x coordinate value to return.
Returns:
the z coordinate stated in the specified unit.

toVector

public Float64Vector toVector(Unit<Length> unit)
Returns the x/y/z coordinates value as a 3-dimensional vector.

Parameters:
unit - the length unit of the vector coordinates.
Returns:
a vector holding the x/y/z coordinates stated in the specified unit.

getCoordinateReferenceSystem

public GeocentricCRS<XYZ> getCoordinateReferenceSystem()
Description copied from class: Coordinates
Returns the reference system for this coordinates.

Specified by:
getCoordinateReferenceSystem in interface org.opengis.spatialschema.geometry.DirectPosition
Specified by:
getCoordinateReferenceSystem in class Coordinates<GeocentricCRS<XYZ>>
Returns:
the associated coordinate reference system.

getDimension

public int getDimension()
Description copied from class: Coordinates
OpenGIS® - The length of coordinate sequence (the number of entries). This is determined by the coordinate reference system.

Specified by:
getDimension in interface org.opengis.spatialschema.geometry.DirectPosition
Specified by:
getDimension in class Coordinates<GeocentricCRS<XYZ>>
Returns:
the dimensionality of this 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<GeocentricCRS<XYZ>>
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.

copy

public XYZ 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<GeocentricCRS<XYZ>>
Returns:
an identical and independant copy of these coordinates .

JScience v4.3

Copyright © 2006 JScience.