// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

namespace Ringtoets.HydraRing.Calculation.Data.Output
{
    /// <summary>
    /// Class containing the results of a Hydra-Ring dunes boundary conditions calculation.
    /// </summary>
    public class DunesBoundaryConditionsCalculationOutput
    {
        /// <summary>
        /// Creates a new instance of <see cref="DunesBoundaryConditionsCalculationOutput"/>.
        /// </summary>
        /// <param name="waterLevel">The calculated water level.</param>
        /// <param name="waveHeight">The calculated wave height.</param>
        /// <param name="wavePeriod">The calculated wave period.</param>
        public DunesBoundaryConditionsCalculationOutput(double waterLevel, double waveHeight, double wavePeriod)
        {
            WaterLevel = waterLevel;
            WaveHeight = waveHeight;
            WavePeriod = wavePeriod;
        }

        /// <summary>
        /// Gets the calculated water level.
        /// </summary>
        public double WaterLevel { get; private set; }

        /// <summary>
        /// Gets the calculated wave height.
        /// </summary>
        public double WaveHeight { get; private set; }

        /// <summary>
        /// Gets the calculated wave period.
        /// </summary>
        public double WavePeriod { get; private set; }
    }
}