// 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 System.Collections.Generic;
using System.Linq;
using Deltares.DamEngine.Data.Standard.Validation;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary>
    /// Holds the soils and provides some handy methods for them
    /// </summary>
    public class SoilList
    {
        private List<Soil> soils;

        public SoilList()
        {
            soils = new List<Soil>();
        }

        /// <summary>
        /// Gets or sets the soils.
        /// </summary>
        /// <value>
        /// The soils.
        /// </value>
        [Validate]
        public virtual List<Soil> Soils
        {
            get
            {
                return soils;
            }
            set
            {
                soils = value;
            }
        }

        /// <summary>
        /// Gets or sets the aquifer dictionary.
        /// This dictionary is used for the backward compatibility issue when aquifers still were part of 
        /// soil instead of the layer as it is now.
        /// </summary>
        /// <value>
        /// The aquifer dictionary.
        /// </value>
        public Dictionary<string, bool> AquiferDictionary { get; set; } = new Dictionary<string, bool>();

        /// <summary>
        /// Gets the index of the soil by its name.
        /// </summary>
        /// <param name="soilName">Name of the soil.</param>
        /// <returns>The index when found else -1</returns>
        public virtual int GetSoilIndexByName(string soilName)
        {
            Soil soil = soils.FirstOrDefault(s => s.Name.Equals(
                                                 soilName, StringComparison.InvariantCultureIgnoreCase));

            return soil == null ? -1 : soils.IndexOf(soil);
        }

        /// <summary>
        /// Gets the soil by its name.
        /// </summary>
        /// <param name="soilName">Name of the soil.</param>
        /// <returns>Soil when found else null</returns>
        public virtual Soil GetSoilByName(string soilName)
        {
            Soil soil = soils.FirstOrDefault(s => s.Name.Equals(
                                                 soilName, StringComparison.InvariantCultureIgnoreCase));

            return soil;
        }

        /// <summary>
        /// Adds the specified soil.
        /// </summary>
        /// <param name="soil">The soil.</param>
        public void Add(Soil soil)
        {
            Soils.Add(soil);
        }

        /// <summary>
        /// Removes the specified soil.
        /// </summary>
        /// <param name="soil">The soil.</param>
        public void Remove(Soil soil)
        {
            Soils.Remove(soil);
            if (AquiferDictionary.ContainsKey(soil.Name))
            {
                AquiferDictionary.Remove(soil.Name);
            }
        }

        /// <summary>
        /// Clears this instance (soils and AquiferDictionary).
        /// </summary>
        public void Clear()
        {
            Soils.Clear();
            AquiferDictionary.Clear();
        }
    }
}