dive4elements/river: artifacts/src/main/java/org/dive4elements/river/artifacts/model/WstLine.java annotate

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/model/WstLine.java @ 7609:b45f6c0b0ba4

Cosmetics, doc fix.

author	Felix Wolfsteller <felix.wolfsteller@intevation.de>
date	Thu, 28 Nov 2013 07:26:36 +0100
parents	05549a84ee83
children

rev	line source
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	2 * Software engineering by Intevation GmbH
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	3 *
5994 af13ceeba52a Removed trailing whitespace. Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	4 * This file is Free Software under the GNU AGPL (>=v3)
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
5994 af13ceeba52a Removed trailing whitespace. Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	6 * documentation coming with Dive4Elements River for details.
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	7 */
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	8
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 446 diff changeset	9 package org.dive4elements.river.artifacts.model;
446 c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	10
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	11 import gnu.trove.TDoubleArrayList;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	12
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	13
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	14 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	15 * A model class that is used to store a line of a WST.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	16 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	17 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	18 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19 public class WstLine {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	20
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	21 /** The kilometer value of the line.*/
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	22 protected double km;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	23
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24 /** The W values.*/
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	25 protected TDoubleArrayList ws;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	26
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27 /** The Q values.*/
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28 protected TDoubleArrayList qs;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	29
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32 * A constructor that builds a new WstLine for a specific kilometer.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	33 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	34 * @param km The kilometer.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	35 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	36 public WstLine(double km) {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	37 this.km = km;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	38 this.ws = new TDoubleArrayList();
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	39 this.qs = new TDoubleArrayList();
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	40 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	41
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	42
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	43 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	44 * Adds a pair of W/Q to this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	45 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	46 * @param w The W value.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	47 * @param q The Q value.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	48 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	49 public void add(double w, double q) {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	50 ws.add(w);
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	51 qs.add(q);
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	52 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	53
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	54
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	55 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56 * Returns the kilometer of this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	58 * @return the kilomter of this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	59 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	60 public double getKm() {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	61 return km;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	62 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	63
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	64
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	65 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	66 * Returns the W value at index <i>idx</i> of this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	67 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	68 * @param idx The position of the desired W value.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	69 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	70 * @return the W at position <i>idx</i>.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72 public double getW(int idx) {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73 return ws.size() > idx ? ws.get(idx) : -1d;
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	74 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	75
7609 b45f6c0b0ba4 Cosmetics, doc fix. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 7604 diff changeset	76
7604 05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	77 /**
7609 b45f6c0b0ba4 Cosmetics, doc fix. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 7604 diff changeset	78 * Returns the Q value at index <i>idx</i> of this line.
7604 05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	79 *
7609 b45f6c0b0ba4 Cosmetics, doc fix. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 7604 diff changeset	80 * @param idx The position of the desired Q value.
7604 05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	81 *
7609 b45f6c0b0ba4 Cosmetics, doc fix. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 7604 diff changeset	82 * @return the Q at position <i>idx</i>.
7604 05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	83 */
05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	84 public double getQ(int idx) {
05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	85 return qs.size() > idx ? qs.get(idx) : -1d;
05549a84ee83 (issue1620) Add export of official lines in WST as specified Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	86 }
446 c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	87
7609 b45f6c0b0ba4 Cosmetics, doc fix. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 7604 diff changeset	88
446 c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	89 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	90 * Returns the Q values of this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	91 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	92 * @return the Q values of this line.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	93 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	94 public double[] getQs() {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	95 return qs.toNativeArray();
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	96 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	97
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	98
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	99 /**
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	100 * Returns the number of columns this line consists of.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	101 *
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102 * @return the columns this line consists of.
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 */
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	104 public int getSize() {
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	105 return qs.size();
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	107 }
c0bec245f608 Implemented writer that creates WSTs and enabled the WaterlevelExporter to create those. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/model/WstLine.java @ 7609:b45f6c0b0ba4