annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/FlowDepthCalculationResults.java @ 8915:d9dbf0b74bc2

Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
author gernotbelger
date Wed, 28 Feb 2018 17:27:15 +0100
parents a66f2a7c4f84
children 5d5d0051723f
rev   line source
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
2 * Software engineering by
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
5 *
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
9 */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.sinfo.flowdepth;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
11
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8882
diff changeset
12 import java.io.Serializable;
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
13 import java.util.ArrayList;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
14 import java.util.Collections;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
15 import java.util.List;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
16
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
17 import org.apache.commons.lang.math.DoubleRange;
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
18 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
19
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
20 /**
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
21 * @author Gernot Belger
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
22 */
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents: 8894
diff changeset
23 final class FlowDepthCalculationResults implements Serializable {
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8882
diff changeset
24 private static final long serialVersionUID = 1L;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8882
diff changeset
25
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
26 private final List<FlowDepthCalculationResult> results = new ArrayList<>();
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
27
8863
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
28 private final String calcModeLabel;
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
29
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
30 private final String user;
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
31
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
32 private final RiverInfo river;
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
33
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
34 private final boolean useTkh;
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
35
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
36 private final DoubleRange calcRange;
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
37
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
38 public FlowDepthCalculationResults(final String calcModeLabel, final String user, final RiverInfo river, final DoubleRange calcRange,
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
39 final boolean useTkh) {
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
40 this.calcModeLabel = calcModeLabel;
8863
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
41 this.user = user;
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
42 this.river = river;
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
43 this.calcRange = calcRange;
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
44 this.useTkh = useTkh;
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
45 }
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
46
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
47 public String getCalcModeLabel() {
8863
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
48 return this.calcModeLabel;
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
49 }
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
50
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
51 public String getUser() {
8863
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
52 return this.user;
1009cab0f86b Some work on flow depth exporter
gernotbelger
parents: 8854
diff changeset
53 }
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
54
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
55 public RiverInfo getRiver() {
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
56 return this.river;
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
57 }
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
58
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
59 public DoubleRange getCalcRange() {
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
60 return this.calcRange;
8882
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
61 }
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
62
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
63 public boolean isUseTkh() {
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
64 return this.useTkh;
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
65 }
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
66
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
67 void addResult(final FlowDepthCalculationResult result) {
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
68 this.results.add(result);
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
69 }
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
70
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
71 public List<FlowDepthCalculationResult> getResults() {
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
72 return Collections.unmodifiableList(this.results);
f762fadc5313 Further work on SINFO-FlowDepth
gernotbelger
parents: 8863
diff changeset
73 }
8894
a66f2a7c4f84 SINFO FlowDepth - slight code cleanup
gernotbelger
parents: 8884
diff changeset
74 }

http://dive4elements.wald.intevation.org