gernotbelger@9067: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9067:  * Software engineering by
gernotbelger@9067:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@9067:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@9067:  *
gernotbelger@9067:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@9067:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@9067:  * documentation coming with Dive4Elements River for details.
gernotbelger@9067:  */
gernotbelger@9067: 
gernotbelger@9067: package org.dive4elements.river.artifacts.sinfo.flood_duration;
gernotbelger@9067: 
gernotbelger@9067: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@9067: import org.apache.log4j.Logger;
gernotbelger@9067: import org.dive4elements.river.artifacts.access.RangeAccess;
gernotbelger@9067: import org.dive4elements.river.artifacts.common.AccessHelper;
gernotbelger@9067: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@9067: import org.dive4elements.river.artifacts.sinfo.SinfoCalcMode;
gernotbelger@9067: 
gernotbelger@9067: import gnu.trove.TDoubleArrayList;
gernotbelger@9067: 
gernotbelger@9067: /**
gernotbelger@9067:  * Access to the flow depth calculation type specific SInfo artifact data.
gernotbelger@9067:  * REMARK: this class is NOT intended to be hold in the results (or anywhere else), in order to avoid a permanent
gernotbelger@9067:  * reference to the artifact instance.
gernotbelger@9067:  * Hence we do NOT cache any data.
gernotbelger@9067:  *
gernotbelger@9067:  * @author Gernot Belger
gernotbelger@9067:  */
gernotbelger@9067: final class FloodDurationAccess extends RangeAccess {
gernotbelger@9067: 
gernotbelger@9067:     private static Logger log = Logger.getLogger(FloodDurationAccess.class);
gernotbelger@9067: 
gernotbelger@9067:     private static final String FIELD_DIFFIDS = "diffids"; //$NON-NLS-1$
gernotbelger@9067: 
gernotbelger@9067:     private static final String FIELD_USE_TKH = "use_transport_bodies"; //$NON-NLS-1$
gernotbelger@9067: 
gernotbelger@9067:     private final AccessHelper helper;
gernotbelger@9067: 
gernotbelger@9067:     /// Fields from state:
gernotbelger@9067: 
gernotbelger@9067:     // calculation_mode (String), sollte sinfo_calc_flood_duration sein
gernotbelger@9067:     // ld_from, ld_to, ld_step
gernotbelger@9067:     // riverside, mögliche werte: "state.sinfo.riverside.left" "state.sinfo.riverside.right" "state.sinfo.riverside.both"
gernotbelger@9067:     // wspl
gernotbelger@9067:     // State.sinfo.WQ:
gernotbelger@9067:     // <data name="wq_isq" type="Boolean" />
gernotbelger@9067:     // <data name="wq_isfree" type="Boolean" />
gernotbelger@9067:     // <data name="wq_isrange" type="Boolean" />
gernotbelger@9067:     // <data name="wq_from" type="Double" />
gernotbelger@9067:     // <data name="wq_to" type="Double" />
gernotbelger@9067:     // <data name="wq_step" type="Double" />
gernotbelger@9067:     // <data name="wq_single" type="Double[]" />
gernotbelger@9067:     public FloodDurationAccess(final SINFOArtifact artifact) {
gernotbelger@9067:         super(artifact);
gernotbelger@9067: 
gernotbelger@9067:         /* assert calculation mode */
gernotbelger@9067:         final SinfoCalcMode calculationMode = artifact.getCalculationMode();
gernotbelger@9067:         this.helper = new AccessHelper(artifact);
gernotbelger@9067:         assert (calculationMode == SinfoCalcMode.sinfo_calc_flood_duration);
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public DoubleRange getRange() {
gernotbelger@9067:         final double from = getFrom();
gernotbelger@9067:         final double to = getTo();
gernotbelger@9067:         return new DoubleRange(from, to);
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     @Override
gernotbelger@9067:     public Double getStep() {
gernotbelger@9067:         return super.getStep();
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public String getRiverside() {
gernotbelger@9067:         return super.getString("riverside");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Boolean getWspl() {
gernotbelger@9067:         return super.getBoolean("wspl");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Boolean getWqIsQ() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         return super.getBoolean("wq_isq");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Boolean getWqIsFree() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         return super.getBoolean("wq_isfree");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Boolean getWqIsRange() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         return super.getBoolean("wq_isrange");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Double getWqFrom() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         if (!getWqIsRange())
gernotbelger@9067:             return null;
gernotbelger@9067: 
gernotbelger@9067:         return super.getDouble("wq_from");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Double getWqTo() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         if (!getWqIsRange())
gernotbelger@9067:             return null;
gernotbelger@9067:         return super.getDouble("wq_to");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public Double getWqStep() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;
gernotbelger@9067:         }
gernotbelger@9067:         if (!getWqIsRange())
gernotbelger@9067:             return null;
gernotbelger@9067: 
gernotbelger@9067:         return super.getDouble("wq_step");
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public double[] getWqSingle() {
gernotbelger@9067:         if (!getWspl()) {
gernotbelger@9067:             return null;//
gernotbelger@9067:         }
gernotbelger@9067:         if (getWqIsRange())
gernotbelger@9067:             return null;
gernotbelger@9067: 
gernotbelger@9067:         final String wqSingles = super.getString("wq_single");
gernotbelger@9067: 
gernotbelger@9067:         if (wqSingles == null || wqSingles.isEmpty()) {
gernotbelger@9067:             log.warn("No wqSingles provided");
gernotbelger@9067:             return null;
gernotbelger@9067:         }
gernotbelger@9067:         final TDoubleArrayList doubles = new gnu.trove.TDoubleArrayList();
gernotbelger@9067:         for (final String value : wqSingles.split(" ")) {
gernotbelger@9067:             try {
gernotbelger@9067: 
gernotbelger@9067:                 doubles.add(Double.parseDouble(value));// Punkt/komma?
gernotbelger@9067:             }
gernotbelger@9067:             catch (final NumberFormatException e) {
gernotbelger@9067:                 /* Client should prevent this */
gernotbelger@9067:                 log.warn("Invalid wqsingle value: " + value);
gernotbelger@9067:                 continue;
gernotbelger@9067:             }
gernotbelger@9067:         }
gernotbelger@9067:         return doubles.toNativeArray();
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067: }