// Copyright (C) Stichting Deltares 2023. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero 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 Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Standard.Language;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary>
    /// 1D Soil Layer Object
    /// </summary>
    public class SoilLayer1D : SoilLayer, ISoilProfileProvider, ICloneable, IComparable<SoilLayer1D>
    {
        /// <summary>
        /// Function delegate to get layer above/beneath via the 1D Profile
        /// </summary>
        /// <param name="layer">The layer.</param>
        /// <returns></returns>
        protected delegate SoilLayer1D LayerGetFunction(SoilLayer1D layer);

        private SoilProfile1D soilProfile;
        private double topLevel;

        /// <summary>
        /// Initializes a new instance of the <see cref="SoilLayer1D"/> class.
        /// </summary>
        public SoilLayer1D()
        {
            Name = LocalizationManager.GetTranslatedText(this, "DefaultNameSoilLayer1D");
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SoilLayer1D"/> class, using given soil and topLevel.
        /// </summary>
        /// <param name="soil">The soil.</param>
        /// <param name="topLevel">The top level.</param>
        public SoilLayer1D(Soil soil, double topLevel)
            : this()
        {
            Soil = soil;
            this.topLevel = topLevel;
        }

        /// <summary>
        /// Gets or sets the toplevel of the layer
        /// </summary>
        public virtual double TopLevel
        {
            get
            {
                return topLevel;
            }
            set
            {
                // don't do anything if top is already value
                if (Math.Abs(value - topLevel) > GeometryConstants.Accuracy)
                {
                    topLevel = value;
                }
            }
        }

        /// <summary>
        /// Gets or sets the bottom level of the layer
        /// </summary>
        /// <value>
        /// The bottom level.
        /// </value>
        public virtual double BottomLevel
        {
            get
            {
                return SoilProfile == null ? 0d : SoilProfile.GetBottomLevel(this);
            }
            set
            {
                // don't do anything if bottom is already value
                if (Math.Abs(value - BottomLevel) > GeometryConstants.Accuracy)
                {
                    var layerBelow = LayerBelow();
                    if (layerBelow != null)
                    {
                        layerBelow.topLevel = value;
                    }
                    else if (SoilProfile != null)
                    {
                        SoilProfile.BottomLevel = value;
                    }

                    if (SoilProfile != null && value < SoilProfile.BottomLevel)
                    {
                        SoilProfile.BottomLevel = value;
                    }
                }
            }
        }

        /// <summary>
        /// Gets the distance between bottom and top.
        /// </summary>
        /// <value>
        /// The height.
        /// </value>
        [Translation("LayerHeight")]
        public double Height
        {
            get
            {
                return TopLevel - BottomLevel;
            }
        }

        /// <summary> Gets or sets the soil profile. </summary>
        /// <remarks> The soil profile is set automatically by the soil layers list in <cref>SoilProfile1D</cref></remarks>
        public SoilProfile1D SoilProfile
        {
            get
            {
                return soilProfile;
            }
            set
            {
                soilProfile = value;
            }
        }

        /// <summary>
        /// Clones this instance.
        /// </summary>
        /// <returns>Clone of this instance</returns>
        public virtual object Clone()
        {
            var clone = new SoilLayer1D();
            clone.Assign(this);
            return clone;
        }

        /// <summary>
        /// Returns the Layer below.
        /// </summary>
        /// <returns>layer below</returns>
        private SoilLayer1D LayerBelow()
        {
            return SoilProfile.GetLayerBelow(this);
        }

        /// <summary>
        /// Assigns the specified layer.
        /// </summary>
        /// <param name="layer">The layer.</param>
        public void Assign(SoilLayer1D layer)
        {
            Name = layer.Name;
            TopLevel = layer.TopLevel;
            Soil = layer.Soil;
            IsAquifer = layer.IsAquifer;
        }

        /// <summary>
        /// Returns a <see cref="System.String" /> that represents this instance.
        /// </summary>
        /// <returns>
        /// A <see cref="System.String" /> that represents this instance.
        /// </returns>
        public override string ToString()
        {
            return Name;
        }

        /// <summary>
        /// Sorting will be applied by the mot uplift layer first
        /// </summary>
        /// <param name="other">Other soil layer</param>
        /// <returns>Comparable indication</returns>
        public int CompareTo(SoilLayer1D other)
        {
            return - TopLevel.CompareTo(other.TopLevel);
        }        
    }
}