mschaefer@9176: /** 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: package org.dive4elements.river.artifacts.sinfo.flood_duration;
gernotbelger@9067: 
mschaefer@9266: import java.util.List;
mschaefer@9266: 
gernotbelger@9067: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@9067: import org.dive4elements.artifacts.CallContext;
mschaefer@9202: import org.dive4elements.river.artifacts.WINFOArtifact;
gernotbelger@9067: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@9067: import org.dive4elements.river.artifacts.model.CalculationResult;
mschaefer@9266: import org.dive4elements.river.artifacts.model.WQDay;
gernotbelger@9067: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@9067: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@9067: import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider;
mschaefer@9176: import org.dive4elements.river.artifacts.sinfo.flood_duration.RiversideRadioChoice.RiversideChoiceKey;
mschaefer@9202: import org.dive4elements.river.artifacts.sinfo.tkhstate.WinfoArtifactWrapper;
gernotbelger@9067: import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils;
mschaefer@9202: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
mschaefer@9266: import org.dive4elements.river.jfree.StickyAxisAnnotation;
gernotbelger@9067: import org.dive4elements.river.model.River;
gernotbelger@9067: 
mschaefer@9176: /**
mschaefer@9176:  * Calculation of the flood durations of the infrastructures of the km range of a river
mschaefer@9176:  *
mschaefer@9176:  * @author Matthias Schäfer
mschaefer@9176:  */
mschaefer@9176: final class FloodDurationCalculation {
gernotbelger@9067: 
gernotbelger@9067:     private final CallContext context;
gernotbelger@9067: 
gernotbelger@9067:     public FloodDurationCalculation(final CallContext context) {
gernotbelger@9067:         this.context = context;
gernotbelger@9067:     }
gernotbelger@9067: 
gernotbelger@9067:     public CalculationResult calculate(final SINFOArtifact sinfo) {
gernotbelger@9067: 
gernotbelger@9067:         final String user = CalculationUtils.findArtifactUser(this.context, sinfo);
gernotbelger@9067: 
gernotbelger@9067:         /* access input data */
gernotbelger@9067:         final FloodDurationAccess access = new FloodDurationAccess(sinfo);
gernotbelger@9067:         final River river = access.getRiver();
mschaefer@9202:         final RiverInfo riverInfo = new RiverInfo(river);
gernotbelger@9067:         final DoubleRange calcRange = access.getRange();
gernotbelger@9067: 
gernotbelger@9067:         final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
gernotbelger@9067:         final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name());
mschaefer@9236:         final String label = Resources.getMsg(this.context.getMeta(), access.getRiverside().getKey());
gernotbelger@9067: 
mschaefer@9176:         final Calculation problems = new Calculation();
mschaefer@9176: 
mschaefer@9202:         // Calculate the selected main values, if any
mschaefer@9202:         /* misuse winfo-artifact to calculate waterlevels in the same way */
mschaefer@9202:         final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
mschaefer@9236:         winfo.addStringData("ld_mode", "distance");
mschaefer@9236:         winfo.addStringData("ld_step", "100");
mschaefer@9202: 
gernotbelger@9215:         final FloodDurationCalculationResults results = new FloodDurationCalculationResults(calcModeLabel, user, riverInfo, calcRange);
mschaefer@9202: 
mschaefer@9252:         calculateResult(label, calcRange, infoProvider, access.getRiverside(), problems, winfo, results);
gernotbelger@9067: 
gernotbelger@9145:         return new CalculationResult(results, problems);
gernotbelger@9145:     }
gernotbelger@9145: 
gernotbelger@9145:     /**
mschaefer@9176:      * Calculates the flood durations of the infrastructures of a km range of a river
gernotbelger@9145:      */
mschaefer@9252:     private void calculateResult(final String label, final DoubleRange calcRange, final RiverInfoProvider riverInfoProvider,
mschaefer@9252:             final RiversideChoiceKey riverside, final Calculation problems, final WINFOArtifact winfo, final FloodDurationCalculationResults results) {
gernotbelger@9145: 
gernotbelger@9150:         final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, riverInfoProvider);
mschaefer@9252:         calculator.execute(problems, label, calcRange, riverside, winfo, results);
gernotbelger@9067:     }
mschaefer@9266: 
mschaefer@9266:     /**
mschaefer@9266:      * Calculates the flood duration curve of a station
mschaefer@9266:      */
mschaefer@9266:     public WQDay calcStationCurve(final double station, final SINFOArtifact sinfo) {
mschaefer@9266: 
mschaefer@9266:         /* access input data */
mschaefer@9266:         final FloodDurationAccess access = new FloodDurationAccess(sinfo);
mschaefer@9266:         final River river = access.getRiver();
mschaefer@9266:         final DoubleRange calcRange = access.getRange();
mschaefer@9266:         final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
mschaefer@9266: 
mschaefer@9266:         final Calculation problems = new Calculation();
mschaefer@9266: 
mschaefer@9266:         // Calculate the selected main values, if any
mschaefer@9266:         /* misuse winfo-artifact to calculate waterlevels in the same way */
mschaefer@9266:         final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
mschaefer@9266:         winfo.addStringData("ld_locations", Double.toString(station));
mschaefer@9266: 
mschaefer@9266:         final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, infoProvider);
mschaefer@9266:         if (!Double.isNaN(station))
mschaefer@9266:             return calculator.calcWQDays(problems, station, winfo);
mschaefer@9266:         else
mschaefer@9266:             return calculator.calcWQDays(problems, calcRange.getMinimumFloat(), winfo);
mschaefer@9266:     }
mschaefer@9266: 
mschaefer@9266:     /**
mschaefer@9266:      * Calculates the annotations of the infrastructure(s) of a station for a flood duration calculation
mschaefer@9266:      */
mschaefer@9266:     public List<StickyAxisAnnotation> calcInfrastructureAnnotations(final double station, final FloodDurationCalculationResult result) {
mschaefer@9266: 
mschaefer@9266:         final Calculation problems = new Calculation();
mschaefer@9266: 
mschaefer@9266:         final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
mschaefer@9266:         return calculator.calcInfrastructureAnnotations(problems, station, result);
mschaefer@9266:     }
mschaefer@9269: 
mschaefer@9269:     /**
mschaefer@9269:      * Calculates the annotations of the W main values of a station
mschaefer@9269:      */
mschaefer@9269:     public List<StickyAxisAnnotation> calcMainValueWAnnotations(final double station, final FloodDurationCalculationResult result) {
mschaefer@9269: 
mschaefer@9269:         final Calculation problems = new Calculation();
mschaefer@9269: 
mschaefer@9269:         final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
mschaefer@9269:         return calculator.calcMainValueWAnnotations(problems, station, result);
mschaefer@9269:     }
mschaefer@9269: 
mschaefer@9269:     /**
mschaefer@9269:      * Calculates the annotations of the Q main values of a station
mschaefer@9269:      */
mschaefer@9269:     public List<StickyAxisAnnotation> calcMainValueQAnnotations(final double station, final FloodDurationCalculationResult result) {
mschaefer@9269: 
mschaefer@9269:         final Calculation problems = new Calculation();
mschaefer@9269: 
mschaefer@9269:         final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
mschaefer@9269:         return calculator.calcMainValueQAnnotations(problems, station, result);
mschaefer@9269:     }
gernotbelger@9067: }