changeset 2679:22c8a9b4de31

Minimal doc, TODO. flys-artifacts/trunk@4377 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Thu, 10 May 2012 09:28:01 +0000
parents d35e37b6a211
children c0fbff11d287
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/geom/Lines.java
diffstat 2 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Thu May 10 09:13:33 2012 +0000
+++ b/flys-artifacts/ChangeLog	Thu May 10 09:28:01 2012 +0000
@@ -1,3 +1,8 @@
+2012-05-10  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/artifacts/geom/Lines.java:
+	  Minimal doc, TODO.
+
 2012-05-10  Felix Wolfsteller <felix.wolfsteller@intevation.de>
 
 	Fix issue620: synchron navigation at impossible kms.
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/geom/Lines.java	Thu May 10 09:13:33 2012 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/geom/Lines.java	Thu May 10 09:28:01 2012 +0000
@@ -70,6 +70,15 @@
     }
 
 
+    /**
+     * For a cross section given as points and a waterlevel (in meters),
+     * create a set of lines that represent the water surface, assuming it
+     * is distributed horizontally equally.
+     * @param points the points describing the river bed.
+     * @param waterLevel the height of the horizontal water line.
+     * @return A list of Lines representing the water surface and the
+     *         calculated area between water surface and river bed.
+     */
     public static ListWithArea fillWater(List<Point2D> points, double waterLevel) {
 
         boolean debug = log.isDebugEnabled();
@@ -95,6 +104,7 @@
                     p.getX(), waterLevel,
                     p.getX(), waterLevel));
             }
+            // TODO continue calculating area.
             return new ListWithArea(result, 0d);
         }
 

http://dive4elements.wald.intevation.org