// 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.GrassCoverErosionInwards.Service
{
    /// <summary>
    /// Class containing the results for a Grass Cover Erosion Inwards calculation.
    /// </summary>
    public class GrassCoverErosionInwardsCalculationServiceOutput
    {
        /// <summary>
        /// Creates a new instance of <see cref="GrassCoverErosionInwardsCalculationServiceOutput"/>.
        /// </summary>
        /// <param name="beta">The beta result of the calculation.</param>
        /// <param name="waveHeight">The wave height result of the calculation.</param>
        /// <param name="isOvertoppingDominant">The value indicating whether overtopping was dominant in the calculation.</param>
        /// <param name="dikeHeight">The dike height result of the calculation.</param>
        public GrassCoverErosionInwardsCalculationServiceOutput(double beta, double waveHeight, bool isOvertoppingDominant, double? dikeHeight)
        {
            Beta = beta;
            WaveHeight = waveHeight;
            IsOvertoppingDominant = isOvertoppingDominant;
            DikeHeight = dikeHeight;
        }

        /// <summary>
        /// Gets the beta result.
        /// </summary>
        public double Beta { get; private set; }

        /// <summary>
        /// Gets the wave height that was a result of the wave height calculation.
        /// </summary>
        public double WaveHeight { get; private set; }

        /// <summary>
        /// Gets whether the overtopping sub failure mechanism was dominant over
        /// the overflow sub failure mechanism.
        /// </summary>
        public bool IsOvertoppingDominant { get; private set; }

        /// <summary>
        /// Gets the dike height that was a result of the dike height calculation.
        /// </summary>
        public double? DikeHeight { get; private set; }
    }
}