Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/XYDepth.java Tue Apr 06 07:01:03 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/XYDepth.java Tue Apr 06 11:05:00 2010 +0000 @@ -3,10 +3,18 @@ import com.vividsolutions.jts.geom.Coordinate; /** - * @author Sascha L. Teichmann + * Interface to encapsulate the query of the depth at a given point. + * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */ public interface XYDepth { + /** + * Returns the depth at a given coordinate. Negative + * values are below the water surface. + * @param coordinate The coordinate where to take the depth. + * @return The depth at the queried coordinate. NaN is no + * depth is available at the given point. + */ double depth(Coordinate coordinate); } -// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8: +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :