// Copyright (C) Stichting Deltares 2017. 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.

using System;
using Core.Common.Base.Geometry;
using Ringtoets.Common.Data.Probabilistics;
using Ringtoets.MacroStabilityInwards.Primitives.Properties;

namespace Ringtoets.MacroStabilityInwards.Data.SoilProfile
{
    /// <summary>
    /// This class represents a preconsolidation stress definition that was imported
    /// from D-Soil model.
    /// </summary>
    public class MacroStabilityInwardsPreconsolidationStress
    {
        /// <summary>
        /// Creates a new instance of <see cref="MacroStabilityInwardsPreconsolidationStress"/>.
        /// </summary>
        /// <param name="location">The location of the preconsolidation stress.</param>
        /// <param name="stressDistribution">The stress distribution belonging to the preconsolidation stress.</param>
        /// <exception cref="ArgumentNullException">Thrown when any parameter is <c>null</c>.</exception>
        /// <exception cref="ArgumentException">Thrown when parameters of <paramref name="location"/> are <see cref="double.NaN"/>.</exception>
        public MacroStabilityInwardsPreconsolidationStress(Point2D location, VariationCoefficientLogNormalDistribution stressDistribution)
        {
            if (location == null)
            {
                throw new ArgumentNullException(nameof(location));
            }
            if (stressDistribution == null)
            {
                throw new ArgumentNullException(nameof(stressDistribution));
            }

            ValidateParameterNaN(location.X, Resources.MacroStabilityInwardsPreconsolidationStress_XCoordinate_ParameterName);
            ValidateParameterNaN(location.Y, Resources.MacroStabilityInwardsPreconsolidationStress_ZCoordinate_ParameterName);

            Location = location;

            Stress = new VariationCoefficientLogNormalDistribution(2)
            {
                Mean = stressDistribution.Mean,
                CoefficientOfVariation = stressDistribution.CoefficientOfVariation
            };
        }

        /// <summary>
        /// Gets the distribution for the preconsolidation stress.
        /// [kN/mē]
        /// </summary>
        public VariationCoefficientLogNormalDistribution Stress { get; }

        /// <summary>
        /// Gets the location of the preconsolidation stress
        /// [m]
        /// </summary>
        /// <remarks>The <see cref="Point2D.Y"/> has the unit [m+NAP]</remarks>
        public Point2D Location { get; }

        public override bool Equals(object obj)
        {
            if (ReferenceEquals(null, obj))
            {
                return false;
            }
            if (ReferenceEquals(this, obj))
            {
                return true;
            }
            if (obj.GetType() != GetType())
            {
                return false;
            }
            return Equals((MacroStabilityInwardsPreconsolidationStress) obj);
        }

        public override int GetHashCode()
        {
            unchecked
            {
                int hashCode = Location.GetHashCode();
                hashCode = (hashCode * 397) ^ Stress.GetHashCode();
                return hashCode;
            }
        }

        /// <summary>
        /// Validates that the <paramref name="value"/> is not a <see cref="double.NaN"/>.
        /// </summary>
        /// <param name="value">The value to validate.</param>
        /// <param name="parameterName">The name of the parameter to validate.</param>
        /// <exception cref="ArgumentException">Thrown when the parameter value is <see cref="double.NaN"/>.</exception>
        private static void ValidateParameterNaN(double value, string parameterName)
        {
            if (double.IsNaN(value))
            {
                string message = string.Format(Resources.MacroStabilityInwardsPreconsolidationStress_ValidateParameter_The_value_of_ParameterName_0_must_be_a_concrete_value, parameterName);
                throw new ArgumentException(message);
            }
        }

        private bool Equals(MacroStabilityInwardsPreconsolidationStress other)
        {
            return Location.Equals(other.Location)
                   && Stress.Equals(other.Stress);
        }
    }
}