// 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.Design;
using Deltares.DamEngine.Data.Geotechnics;
using Deltares.DamEngine.Data.Standard;
using Deltares.DamEngine.Data.Standard.Calculation;

namespace Deltares.DamEngine.Data.General.Results;

/// <summary>
/// Contains the results for the design calculations.
/// </summary>
/// <seealso cref="System.ICloneable" />
public class DesignResult : ICloneable
{
    private double? safetyFactor;

    /// <summary>
    /// Initializes a new instance of the <see cref="DesignResult"/> class.
    /// Is only to be used by this.Clone() and in FillDamFromXmlOutput (used in tests), nowhere else
    /// </summary>
    internal DesignResult()
    {
        // only for Clone() method
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="DesignResult"/> class.
    /// Needed for testing purposes.
    /// </summary>
    /// <param name="locationName">Name of the location.</param>
    /// <param name="scenarioName">Name of the scenario.</param>
    public DesignResult(string locationName, string scenarioName)
    {
        this.LocationName = locationName;
        this.ScenarioName = scenarioName;
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="DesignResult"/> class.
    /// </summary>
    /// <param name="damFailureMechanismeCalculationSpecification">The dam failure mechanisme calculation specification.</param>
    /// <param name="scenario">The scenario.</param>
    /// <param name="soilProfile">The soil profile.</param>
    /// <param name="soilGeometry2DName">Name of the soil geometry2 d.</param>
    public DesignResult(DamFailureMechanismeCalculationSpecification damFailureMechanismeCalculationSpecification,
                        DesignScenario scenario, SoilProfile1D soilProfile, string soilGeometry2DName)
    {
        if (scenario != null)
        {
            LocationName = scenario.Location.Name;
            ScenarioName = scenario.LocationScenarioID;
        }

        BaseFileName = "";
        CalculationSubDir = "";
        DamFailureMechanismeCalculation = damFailureMechanismeCalculationSpecification;
        Scenario = scenario;

        if (damFailureMechanismeCalculationSpecification != null)
        {
            switch (damFailureMechanismeCalculationSpecification.FailureMechanismSystemType)
            {
                case FailureMechanismSystemType.StabilityInside:
                case FailureMechanismSystemType.StabilityOutside:
                    ProfileName = soilGeometry2DName;
                    break;
                case FailureMechanismSystemType.Piping:
                    ProfileName = soilProfile.Name;
                    break;
            }
        }
    }

    /// <summary>
    /// Gets or sets the safety factor.
    /// Note: this is a placeholder, not to be part of the results as written to xml
    /// </summary>
    /// <value>
    /// The safety factor.
    /// </value>
    public double? SafetyFactor
    {
        get
        {
            if (DamFailureMechanismeCalculation != null)
            {
                switch (DamFailureMechanismeCalculation.FailureMechanismSystemType)
                {
                    case FailureMechanismSystemType.StabilityInside:
                    case FailureMechanismSystemType.StabilityOutside:
                        return StabilityDesignResults.SafetyFactor;
                    case FailureMechanismSystemType.Piping:
                        return PipingDesignResults.SafetyFactor;
                }
            }

            return safetyFactor;
        }
        set
        {
            if (DamFailureMechanismeCalculation != null)
            {
                if (DamFailureMechanismeCalculation.FailureMechanismSystemType == FailureMechanismSystemType.Piping)
                {
                    PipingDesignResults.SafetyFactor = value;
                }
                else
                {
                    StabilityDesignResults.SafetyFactor = value;
                }
            }

            safetyFactor = value;
        }
    }

    /// <summary>
    /// Gets or sets the dam failure mechanisme calculation.
    /// Note: this is a placeholder, not to be part of the results as written to xml
    /// </summary>
    /// <value>
    /// The dam failure mechanisme calculation.
    /// </value>
    public DamFailureMechanismeCalculationSpecification DamFailureMechanismeCalculation { get; set; }

    /// <summary>
    /// Gets or sets the scenario.
    /// Note: this is a placeholder, not to be part of the results as written to xml
    /// </summary>
    /// <value>
    /// The scenario.
    /// </value>
    public DesignScenario Scenario { get; set; }

    //Identifiers, needed to retrace the origin of the result
    /// <summary>
    /// Gets the name of the location.
    /// For identification purpose
    /// </summary>
    /// <value>
    /// The name of the location.
    /// </value>
    public string LocationName { get; private set; }

    /// <summary>
    /// Gets the name of the scenario.
    /// For identification purpose
    /// </summary>
    /// <value>
    /// The name of the scenario.
    /// </value>
    public string ScenarioName { get; private set; }

    /// <summary>
    /// Gets or sets the name of the profile.
    /// For identification purpose
    /// </summary>
    /// <value>
    /// The name of the profile.
    /// </value>
    public string ProfileName { get; set; }

    /// <summary>
    /// Gets or sets the name of the base file.
    /// </summary>
    /// <value>
    /// The name of the base file.
    /// Can be used to retrace results files.
    /// </value>
    public string BaseFileName // real result for all.
    {
        get;
        set;
    }

    /// <summary>
    /// Gets or sets the calculation sub dir (as relative path).
    /// </summary>
    /// <value>
    /// The calculation sub dir.
    /// </value>
    public string CalculationSubDir { get; set; }

    /// <summary>
    /// Gets or sets the calculation result.
    /// This is a derived result.
    /// </summary>
    /// <value>
    /// The calculation result.
    /// </value>
    public CalculationResult CalculationResult { get; set; } = CalculationResult.NoRun;

    /// <summary>
    /// Gets or sets the stability design results.
    /// </summary>
    /// <value>
    /// The stability design results.
    /// </value>
    public StabilityDesignResults StabilityDesignResults { get; set; }

    /// <summary>
    /// Gets or sets the piping design results.
    /// </summary>
    /// <value>
    /// The piping design results.
    /// </value>
    public PipingDesignResults PipingDesignResults { get; set; }

    /// <summary>
    /// Make a clone of object
    /// </summary>
    /// <returns></returns>
    public object Clone()
    {
        var designResult = new DesignResult();

        designResult.Assign(this);

        return designResult;
    }

    /// <summary>
    /// Copy data
    /// </summary>
    /// <param name="designResult"></param>
    private void Assign(DesignResult designResult)
    {
        // copy place holders
        DamFailureMechanismeCalculation = designResult.DamFailureMechanismeCalculation;
        Scenario = designResult.Scenario;

        // copy direct data
        BaseFileName = designResult.BaseFileName;
        CalculationSubDir = designResult.CalculationSubDir;
        LocationName = designResult.LocationName;
        ScenarioName = designResult.ScenarioName;
        ProfileName = designResult.ProfileName;
        CalculationResult = designResult.CalculationResult;
        safetyFactor = designResult.SafetyFactor;
        StabilityDesignResults = new StabilityDesignResults();
        designResult.StabilityDesignResults.CloneProperties(StabilityDesignResults);
        PipingDesignResults = new PipingDesignResults(DamFailureMechanismeCalculation.PipingModelType);
        designResult.PipingDesignResults.CloneProperties(PipingDesignResults);
    }
}