// Copyright (C) Stichting Deltares 2024. 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.Design;
using Deltares.DamEngine.Data.General.Gauges;
using Deltares.DamEngine.Data.General.PlLines;
using Deltares.DamEngine.Data.General.Sensors;
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Geotechnics;
using Deltares.DamEngine.Data.Standard.Validation;

namespace Deltares.DamEngine.Data.General;

public class Location
{
    // Added initial value as these properties must be tested for real values on import

    // Start of parameters that are also defined in ModelParameters

    private string name = "";
    private SensorLocation sensorLocation;

    /// <summary>
    /// Initializes a new instance of the <see cref="Location"/> class.
    /// </summary>
    public Location()
    {
        SoilList = null;
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="Location"/> class.
    /// </summary>
    /// <param name="name">The name.</param>
    public Location(string name) : this()
    {
        this.name = name;
    }

    /// <summary>
    /// Gets a value indicating whether this instance has a sensor location.
    /// </summary>
    /// <value>
    ///   <c>true</c> if this instance has a sensor location; otherwise, <c>false</c>.
    /// </value>
    public bool HasSensorLocation
    {
        get
        {
            return sensorLocation != null;
        }
    }

    /// <summary>
    /// Gets or sets the distance to entry point (can be used for Piping Sellmeijer).
    /// </summary>
    /// <value>
    /// The distance to entry point.
    /// </value>
    public double DistanceToEntryPoint { get; set; }

    /// <summary>
    /// Gets or sets the sensor location.
    /// </summary>
    /// <value>
    /// The sensor location.
    /// </value>
    public virtual SensorLocation SensorLocation
    {
        get
        {
            return sensorLocation;
        }
        set
        {
            sensorLocation = value;
            sensorLocation.Location = this;
        }
    }

    /// <summary>
    /// Gets or sets the name.
    /// </summary>
    /// <value>
    /// The name.
    /// </value>
    public virtual string Name
    {
        get
        {
            return name;
        }
        set
        {
            name = value;
        }
    }

    /// <summary>
    /// Gets or sets the x rd dike line (for sensors).
    /// </summary>
    /// <value>
    /// The x rd dike line.
    /// </value>
    public virtual double XRdDikeLine { get; set; }

    /// <summary>
    /// Gets or sets the local XZPL1 line.
    /// </summary>
    /// <value>
    /// The local XZPL1 line.
    /// </value>
    public virtual Pl1Line LocalXzpl1Line { get; set; }

    /// <summary>
    /// The surfaceline in local coordinates 
    /// </summary>
    /// <remarks>Composite relationship.</remarks>
    [Validate]
    public virtual SurfaceLine2 SurfaceLine { get; set; }

    /// <summary>
    /// Gets or sets the Segment
    /// </summary>
    public virtual Segment Segment { get; set; }

    /// <summary>
    /// Gets or sets the slope damping piezometric height polder side.
    /// </summary>
    /// <value>
    /// The slope damping piezometric height polder side.
    /// </value>
    public virtual double SlopeDampingPiezometricHeightPolderSide { get; set; }

    /// <summary>
    /// Gets or sets the height of the dike table.
    /// </summary>
    /// <value>
    /// The height of the dike table.
    /// </value>
    public virtual double DikeTableHeight { get; set; }

    /// <summary>
    /// Gets or sets the soil list.
    /// </summary>
    /// <value>
    /// The soil list.
    /// </value>
    public SoilList SoilList { get; set; }
    
    /// <summary>
    /// Gets or sets the degree of consolidation of the soils (consolidated) due to the traffic load (consolidator).
    /// </summary>
    public IList<TrafficLoadDegreeOfConsolidation> TrafficLoadDegreeOfConsolidations { get; set; }

    /// <summary>
    /// Gets or sets the gauges.
    /// </summary>
    /// <value>
    /// The gauges.
    /// </value>
    public virtual IList<Gauge> Gauges { get; set; } = new List<Gauge>();

    /// <summary>
    /// Gets or sets the gauge pl lines.
    /// </summary>
    /// <value>
    /// The gauge pl lines.
    /// </value>
    public virtual IList<GaugePlLine> GaugePlLines { get; set; } = new List<GaugePlLine>();

    /// <summary>
    /// Gets or sets a value indicating whether [redesign dike height].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [redesign dike height]; otherwise, <c>false</c>.
    /// </value>
    public bool RedesignDikeHeight { get; set; } = true;

    /// <summary>
    /// Gets or sets a value indicating whether [redesign dike shoulder].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [redesign dike shoulder]; otherwise, <c>false</c>.
    /// </value>
    public bool RedesignDikeShoulder { get; set; } = true;

    /// <summary>
    /// Gets or sets the stability design method.
    /// </summary>
    /// <value>
    /// The stability design method.
    /// </value>
    public StabilityDesignMethod StabilityDesignMethod { get; set; } = StabilityDesignMethod.OptimizedSlopeAndShoulderAdaption;

    /// <summary>
    /// Gets or sets the slope adaption start cotangent.
    /// </summary>
    /// <value>
    /// The slope adaption start cotangent.
    /// </value>
    public double SlopeAdaptionStartCotangent { get; set; } = 3.0;

    /// <summary>
    /// Gets or sets the slope adaption end cotangent.
    /// </summary>
    /// <value>
    /// The slope adaption end cotangent.
    /// </value>
    public double SlopeAdaptionEndCotangent { get; set; } = 6.0;

    /// <summary>
    /// Gets or sets the slope adaption step cotangent.
    /// </summary>
    /// <value>
    /// The slope adaption step cotangent.
    /// </value>
    public double SlopeAdaptionStepCotangent { get; set; } = 0.5;

    /// <summary>
    /// Gets or sets a value indicating whether [use new dike top width].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new dike top width]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewDikeTopWidth { get; set; }

    /// <summary>
    /// Gets or sets the new width of the dike top.
    /// </summary>
    /// <value>
    /// The new width of the dike top.
    /// </value>
    public double NewDikeTopWidth { get; set; } = 5.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new dike slope inside].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new dike slope inside]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewDikeSlopeInside { get; set; }

    /// <summary>
    /// Gets or sets the new dike slope inside.
    /// </summary>
    /// <value>
    /// The new dike slope inside.
    /// </value>
    public double NewDikeSlopeInside { get; set; } = 1.0 / 3.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new dike slope outside].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new dike slope outside]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewDikeSlopeOutside { get; set; }

    /// <summary>
    /// Gets or sets the new dike slope outside.
    /// </summary>
    /// <value>
    /// The new dike slope outside.
    /// </value>
    public double NewDikeSlopeOutside { get; set; } = 1.0 / 3.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new shoulder top slope].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new shoulder top slope]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewShoulderTopSlope { get; set; }

    /// <summary>
    /// Gets or sets the new shoulder top slope.
    /// </summary>
    /// <value>
    /// The new shoulder top slope.
    /// </value>
    public double NewShoulderTopSlope { get; set; } = 1.0 / 20.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new shoulder base slope].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new shoulder base slope]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewShoulderBaseSlope { get; set; }

    /// <summary>
    /// Gets or sets the new shoulder base slope.
    /// </summary>
    /// <value>
    /// The new shoulder base slope.
    /// </value>
    public double NewShoulderBaseSlope { get; set; } = 1.0 / 3.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new maximum height shoulder as fraction].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new maximum height shoulder as fraction]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewMaxHeightShoulderAsFraction { get; set; }

    /// <summary>
    /// Gets or sets the new maximum height shoulder as fraction.
    /// </summary>
    /// <value>
    /// The new maximum height shoulder as fraction.
    /// </value>
    public double NewMaxHeightShoulderAsFraction { get; set; } = 2.0 / 3.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new minimum distance dike toe start ditch].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new minimum distance dike toe start ditch]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewMinDistanceDikeToeStartDitch { get; set; }

    /// <summary>
    /// Gets or sets the new minimum distance dike toe start ditch.
    /// </summary>
    /// <value>
    /// The new minimum distance dike toe start ditch.
    /// </value>
    public double NewMinDistanceDikeToeStartDitch { get; set; } = 5.0;

    /// <summary>
    /// Gets or sets a value indicating whether [use new ditch definition].
    /// </summary>
    /// <value>
    ///   <c>true</c> if [use new ditch definition]; otherwise, <c>false</c>.
    /// </value>
    public bool UseNewDitchDefinition { get; set; }

    /// <summary>
    /// Gets or sets the new width ditch bottom.
    /// </summary>
    /// <value>
    /// The new width ditch bottom.
    /// </value>
    public double NewWidthDitchBottom { get; set; } = 1.0;

    /// <summary>
    /// Gets or sets the new slope angle ditch.
    /// </summary>
    /// <value>
    /// The new slope angle ditch.
    /// </value>
    public double NewSlopeAngleDitch { get; set; } = 1.0 / 0.5;

    /// <summary>
    /// Gets or sets the new depth ditch.
    /// </summary>
    /// <value>
    /// The new depth ditch.
    /// </value>
    public double NewDepthDitch { get; set; } = 1.0;

    /// <summary>
    /// Gets the scenarios.
    /// </summary>
    /// <value>
    /// The scenarios.
    /// </value>
    [Validate]
    public List<DesignScenario> Scenarios { get; } = new List<DesignScenario>();

    /// <summary>
    /// Gets or sets the current scenario.
    /// </summary>
    /// <value>
    /// The current scenario.
    /// </value>
    public DesignScenario CurrentScenario { get; set; }

    /// <summary>
    /// Gets or sets the type of the dam project.
    /// </summary>
    /// <value>
    /// The type of the dam project.
    /// </value>
    public static DamProjectType DamProjectType { get; set; } = DamProjectType.Operational;

    /// <summary>
    /// Gets or sets the stability options.
    /// </summary>
    /// <value>
    /// The stability options.
    /// </value>
    public StabilityOptions StabilityOptions { get; set; }

    /// <summary>
    /// Gets or sets the model parameters for pl lines.
    /// </summary>
    /// <value>
    /// The model parameters for pl lines.
    /// </value>
    public ModelParametersForPlLines ModelParametersForPlLines { get; set; } = new ModelParametersForPlLines();

    /// <summary>
    /// Gets the dike embankment soil.
    /// </summary>
    /// <returns></returns>
    public Soil GetDikeEmbankmentSoil()
    {
        if (SoilList != null && SoilList.Soils.Count > 0 && !String.IsNullOrEmpty(DikeEmbankmentMaterial))
        {
            return SoilList.GetSoilByName(DikeEmbankmentMaterial);
        }

        return null;
    }

    /// <summary>
    /// Gets the shoulder embankment soil.
    /// </summary>
    /// <returns></returns>
    public Soil GetShoulderEmbankmentSoil()
    {
        Soil soil = null;
        if (SoilList != null && SoilList.Soils.Count > 0 && !String.IsNullOrEmpty(ShoulderEmbankmentMaterial))
        {
            soil = SoilList.GetSoilByName(ShoulderEmbankmentMaterial);
        }

        if (soil == null)
        {
           soil =  GetDikeEmbankmentSoil();
        }
        return soil;
    }

    /// <summary>
    /// Aligns the boundary points of PL1 line with adapted surface line.
    /// </summary>
    /// <param name="adaptedSurfaceLine">The adapted surface line.</param>
    public void AlignBoundaryPointsOfPl1LineWithAdaptedSurfaceLine(SurfaceLine2 adaptedSurfaceLine)
    {
        if ((LocalXzpl1Line != null) && (LocalXzpl1Line.CalcPoints.Count > 1))
        {
            Point2D lastPointPl1Line = LocalXzpl1Line.CalcPoints.Last();
            Point2D lastPointSurfaceLine = adaptedSurfaceLine.Geometry.CalcPoints.Last();
            lastPointPl1Line.X = lastPointSurfaceLine.X;
            Point2D firstPointPl1Line = LocalXzpl1Line.CalcPoints.First();
            Point2D firstPointSurfaceLine = adaptedSurfaceLine.Geometry.CalcPoints.First();
            firstPointPl1Line.X = firstPointSurfaceLine.X;
        }
    }

    /// <summary>
    /// Adds a new sensor location.
    /// </summary>
    public void AddSensorLocation()
    {
        var factory = new SensorFactory();
        SensorLocation = factory.CreateSensorLocation(this);
    }

    /// <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;
    }

    #region Design parameters

    /// <summary>
    /// Gets or sets the dike embankment material.
    /// </summary>
    /// <value>
    /// The dike embankment material.
    /// </value>
    public virtual string DikeEmbankmentMaterial { get; set; } = "";

    /// <summary>
    /// Gets or sets the shoulder embankment material.
    /// </summary>
    /// <value>
    /// The shoulder embankment material.
    /// </value>
    public virtual string ShoulderEmbankmentMaterial { get; set; } = "";

    /// <summary>
    /// Gets or sets the stability shoulder grow slope.
    /// </summary>
    /// <value>
    /// The stability shoulder grow slope.
    /// </value>
    public virtual double StabilityShoulderGrowSlope { get; set; } = 1.0 / 3;

    /// <summary>
    /// Gets or sets the stability shoulder grow delta x.
    /// </summary>
    /// <value>
    /// The stability shoulder grow delta x.
    /// </value>
    public virtual double StabilityShoulderGrowDeltaX { get; set; } = 2.0;

    /// <summary>
    /// Gets or sets the stability slope adaption delta x.
    /// </summary>
    /// <value>
    /// The stability slope adaption delta x.
    /// </value>
    public virtual double StabilitySlopeAdaptionDeltaX { get; set; } = 2.0;

    #endregion

    #region PlLine creation parameters

    /// <summary>
    /// Gets or sets the intrusion vertical water pressure.
    /// </summary>
    /// <value>
    /// The intrusion vertical water pressure.
    /// </value>
    public IntrusionVerticalWaterPressureType? IntrusionVerticalWaterPressure { get; set; } = IntrusionVerticalWaterPressureType.Standard;

    #endregion
}