comparison gnv-artifacts/src/main/java/de/intevation/gnv/math/XYDepth.java @ 798:6cff63d0c434

Fixed vim modeline. Added some Javadoc. gnv-artifacts/trunk@880 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 06 Apr 2010 11:05:00 +0000
parents 828df3ddb758
children f953c9a559d8
comparison
equal deleted inserted replaced
797:9d2891068ba5 798:6cff63d0c434
1 package de.intevation.gnv.math; 1 package de.intevation.gnv.math;
2 2
3 import com.vividsolutions.jts.geom.Coordinate; 3 import com.vividsolutions.jts.geom.Coordinate;
4 4
5 /** 5 /**
6 * @author Sascha L. Teichmann 6 * Interface to encapsulate the query of the depth at a given point.
7 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
7 */ 8 */
8 public interface XYDepth 9 public interface XYDepth
9 { 10 {
11 /**
12 * Returns the depth at a given coordinate. Negative
13 * values are below the water surface.
14 * @param coordinate The coordinate where to take the depth.
15 * @return The depth at the queried coordinate. NaN is no
16 * depth is available at the given point.
17 */
10 double depth(Coordinate coordinate); 18 double depth(Coordinate coordinate);
11 } 19 }
12 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8: 20 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org