org.kalypso.ui.rrm.internal.calccase.LinearSumCatchmentModelInfo.java Source code

Introduction

Here is the source code for org.kalypso.ui.rrm.internal.calccase.LinearSumCatchmentModelInfo.java

Source

/*----------------    FILE HEADER KALYPSO ------------------------------------------
 *
 *  This file is part of kalypso.
 *  Copyright (C) 2004 by:
 * 
 *  Technical University Hamburg-Harburg (TUHH)
 *  Institute of River and coastal engineering
 *  Denickestrae 22
 *  21073 Hamburg, Germany
 *  http://www.tuhh.de/wb
 * 
 *  and
 *  
 *  Bjoernsen Consulting Engineers (BCE)
 *  Maria Trost 3
 *  56070 Koblenz, Germany
 *  http://www.bjoernsen.de
 * 
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 * 
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 *  Contact:
 * 
 *  E-Mail:
 *  belger@bjoernsen.de
 *  schlienger@bjoernsen.de
 *  v.doemming@tuhh.de
 *   
 *  ---------------------------------------------------------------------------*/
package org.kalypso.ui.rrm.internal.calccase;

import java.util.Date;

import javax.xml.namespace.QName;

import org.joda.time.LocalTime;
import org.joda.time.Period;
import org.kalypso.model.hydrology.binding.cm.ILinearSumGenerator;
import org.kalypso.model.hydrology.binding.control.NAControl;
import org.kalypso.model.hydrology.binding.model.NaModell;
import org.kalypso.model.hydrology.project.RrmSimulation;
import org.kalypso.model.rcm.binding.IRainfallGenerator;
import org.kalypso.ogc.sensor.DateRange;

/**
 * The catchment model info object can be used to execute {@link AbstractCatchmentModelRunner}'s.
 * 
 * @author Holger Albert
 */
public class LinearSumCatchmentModelInfo implements ICatchmentModelInfo {
    /**
     * The simulation.
     */
    private final RrmSimulation m_simulation;

    /**
     * The na control.
     */
    private final NAControl m_control;

    /**
     * The na model.
     */
    private final NaModell m_model;

    /**
     * The generator.
     */
    private final ILinearSumGenerator m_generator;

    /**
     * The target link.
     */
    private final QName m_targetLink;

    /**
     * The parameter type.
     */
    private final String m_parameterType;

    /**
     * The constructor.
     * 
     * @param simulation
     *          The simulation.
     * @param control
     *          The na control.
     * @param model
     *          The na model.
     * @param generator
     *          The generator.
     * @param targetLink
     *          The target link.
     * @param parameterType
     *          The parameter type.
     */
    public LinearSumCatchmentModelInfo(final RrmSimulation simulation, final NAControl control,
            final NaModell model, final ILinearSumGenerator generator, final QName targetLink,
            final String parameterType) {
        m_simulation = simulation;
        m_control = control;
        m_model = model;
        m_generator = generator;
        m_targetLink = targetLink;
        m_parameterType = parameterType;
    }

    @Override
    public RrmSimulation getSimulation() {
        return m_simulation;
    }

    @Override
    public NAControl getControl() {
        return m_control;
    }

    @Override
    public NaModell getModel() {
        return m_model;
    }

    @Override
    public IRainfallGenerator getGenerator() {
        return m_generator;
    }

    @Override
    public QName getTargetLink() {
        return m_targetLink;
    }

    @Override
    public String getParameterType() {
        return m_parameterType;
    }

    @Override
    public Period getTimestep() {
        Integer timestep = m_generator.getTimestep();
        if (timestep == null)
            timestep = m_control.getMinutesOfTimestep();

        final int timestepMinutes = timestep.intValue();
        final Period minutes = Period.minutes(timestepMinutes);

        return minutes.normalizedStandard();
    }

    @Override
    public LocalTime getTimestamp() {
        return m_generator.getTimestamp();
    }

    @Override
    public DateRange getSimulationRange() {
        final NAControl control = m_control;
        final Period timestep = getTimestep();
        final LocalTime timestamp = getTimestamp();

        return CatchmentModelHelper.getRange(control, timestep, timestamp);
    }

    @Override
    public DateRange getUnadjustedSimulationRange() {
        final Date simulationStart = m_control.getSimulationStart();
        final Date simulationEnd = m_control.getSimulationEnd();
        final DateRange unadjustedSimulationRange = new DateRange(simulationStart, simulationEnd);

        return unadjustedSimulationRange;
    }
}