view gnv-artifacts/src/main/java/de/intevation/gnv/math/XYDepth.java @ 809:d05b17a4f3d0

Added javadoc in describedata package. gnv-artifacts/trunk@891 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Fri, 09 Apr 2010 07:27:38 +0000
parents 6cff63d0c434
children f953c9a559d8
line wrap: on
line source
package de.intevation.gnv.math;

import com.vividsolutions.jts.geom.Coordinate;

/**
 * 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 :

http://dive4elements.wald.intevation.org