001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/model/spatialschema/Position.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53115 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042
043 ---------------------------------------------------------------------------*/
044 package org.deegree.model.spatialschema;
045
046 /**
047 * A sequence of decimals numbers which when written on a width are a sequence of coordinate
048 * positions. The width is derived from the CRS or coordinate dimension of the container.
049 *
050 * <p>
051 * -----------------------------------------------------------------------
052 * </p>
053 *
054 * @version 5.6.2001
055 * @author Andreas Poth
056 * <p>
057 */
058 public interface Position {
059 /**
060 * @return the x-value of the point
061 */
062 public double getX();
063
064 /**
065 * @return the y-value of the point
066 */
067 public double getY();
068
069 /**
070 * @return the z-value of the point
071 */
072 public double getZ();
073
074 /**
075 * @return the coordinate dimension of the position
076 */
077 public int getCoordinateDimension();
078
079 /**
080 * NOTE: The returned array always has a length of 3, regardless of the dimension. This is due
081 * to a limitation in the coordinate transformation package (proj4), which expects coordinates
082 * to have 3 dimensions.
083 *
084 * @return the x- and y-value of the point as a two dimensional array the first field contains
085 * the x- the second field the y-value.
086 *
087 */
088 public double[] getAsArray();
089
090 /**
091 * translates the coordinates of the position.
092 *
093 * @param d
094 * the first coordinate of the position will be translated by the first field of
095 * <tt>d</tt> the second coordinate by the second field of <tt>d</tt> and so
096 * on...
097 */
098 public void translate( double[] d );
099
100 /**
101 * returns the accuracy the position is defined. The accuracy is measured in values of the CRS
102 * the positions coordinates are stored
103 *
104 * @return the accuracy the position is defined
105 */
106 public double getAccuracy();
107
108 /**
109 * @see #getAccuracy()
110 * @param accuracy
111 */
112 public void setAccuracy( double accuracy );
113
114 }