// Copyright (C) Stichting Deltares 2019. 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 Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.General.Results;
using Deltares.DamEngine.Data.Standard.Logging;

namespace Deltares.DamEngine.Data.RegionalAssessmentResults
{
    /// <summary>
    /// Class for results of one particular regional scenario per profile
    /// </summary>
    public class RegionalScenarioProfileJob: RegionalResult
    {
        private FailureMechanismSystemType failureMechanismType = FailureMechanismSystemType.StabilityInside;
        private DikeDrySensitivity dikeDrySensitivity = DikeDrySensitivity.None;
        private HydraulicShortcutType hydraulicShortcutType = HydraulicShortcutType.NoHydraulicShortcut;
        private UpliftType upliftType = UpliftType.NoUplift;
        private LoadSituation loadSituation = LoadSituation.Wet;
        private MStabModelType mstabModelOption;
        private PipingModelType pipingModelOption;

        private readonly SoilGeometryProbability soilGeometryProbability;
        private readonly Location location;

        private ScenarioType scenarioType = ScenarioType.Scenario01;
        private string baseFileName = "";

        /// <summary>
        /// Initializes a new instance of the <see cref="RegionalScenarioProfileJob"/> class.
        /// </summary>
        /// <param name="location">The location.</param>
        /// <param name="soilGeometryProbability">The soil geometry probability.</param>
        public RegionalScenarioProfileJob(Location location, SoilGeometryProbability soilGeometryProbability)
        {
            this.location = location;
            this.soilGeometryProbability = soilGeometryProbability;
        }

        /// <summary>
        /// Gets the location.
        /// </summary>
        /// <value>
        /// The location.
        /// </value>
        public Location Location
        {
            get
            {
                return location;
            }
        }


        /// <summary>
        /// The calculation category (constant value)
        /// </summary>
        public const string CalculationCategory = "Calculation";

        /// <summary>
        /// Gets the name of the location.
        /// </summary>
        /// <value>
        /// The name of the location.
        /// </value>
        public string LocationName
        {
            get { return location.Name; }
        }

        /// <summary>
        /// Gets or sets the load situation.
        /// </summary>
        /// <value>
        /// The load situation.
        /// </value>
        public LoadSituation LoadSituation
        {
            get { return loadSituation; }
            set { loadSituation = value; }
        }

        /// <summary>
        /// Gets or sets the dike dry sensitivity.
        /// </summary>
        /// <value>
        /// The dike dry sensitivity.
        /// </value>
        public DikeDrySensitivity DikeDrySensitivity
        {
            get { return dikeDrySensitivity; }
            set { dikeDrySensitivity = value; }
        }

        /// <summary>
        /// Gets or sets the type of the hydraulic shortcut.
        /// </summary>
        /// <value>
        /// The type of the hydraulic shortcut.
        /// </value>
        public HydraulicShortcutType HydraulicShortcutType
        {
            get { return hydraulicShortcutType; }
            set { hydraulicShortcutType = value; }
        }

        /// <summary>
        /// Gets or sets the type of the uplift.
        /// </summary>
        /// <value>
        /// The type of the uplift.
        /// </value>
        public UpliftType UpliftType
        {
            get { return upliftType; }
            set { upliftType = value; }
        }

        /// <summary>
        /// Gets or sets the mstab model option.
        /// </summary>
        /// <value>
        /// The mstab model option.
        /// </value>
        public MStabModelType MstabModelOption
        {
            get { return mstabModelOption; }
            set { mstabModelOption = value; }
        }

        /// <summary>
        /// Gets or sets the piping model option.
        /// </summary>
        /// <value>
        /// The piping model option.
        /// </value>
        public PipingModelType PipingModelOption
        {
            get { return pipingModelOption; }
            set { pipingModelOption = value; }
        }

        /// <summary>
        /// Gets or sets the type of the scenario.
        /// </summary>
        /// <value>
        /// The type of the scenario.
        /// </value>
        public ScenarioType ScenarioType
        {
            get { return scenarioType; }
            set { scenarioType = value; }
        }

        /// <summary>
        /// Gets or sets the name of the base file.
        /// </summary>
        /// <value>
        /// The name of the base file.
        /// </value>
        public string BaseFileName
        {
            get { return baseFileName; }
            set { baseFileName = value; }
        }

        /// <summary>
        /// Gets or sets the type of the failure mechanism.
        /// </summary>
        /// <value>
        /// The type of the failure mechanism.
        /// </value>
        public FailureMechanismSystemType FailureMechanismType
        {
            get { return failureMechanismType; }
            set { failureMechanismType = value; }
        }

        /// <summary>
        /// Gets the soil geometry probability.
        /// </summary>
        /// <value>
        /// The soil geometry probability.
        /// </value>
        public SoilGeometryProbability SoilGeometryProbability
        {
            get { return soilGeometryProbability; }
        }

        /// <summary>
        /// Gets the name of the soil profile.
        /// </summary>
        /// <value>
        /// The name of the soil profile.
        /// </value>
        public string SoilProfileName
        {
            get
            {
                return soilGeometryProbability.SoilProfile1D.Name;
            }
        }

        /// <summary>
        /// Gets the soil profile probability.
        /// </summary>
        /// <value>
        /// The soil profile probability.
        /// </value>
        public double SoilProfileProbability
        {
            get
            {
                return soilGeometryProbability.Probability;
            }
        }

        /// <summary>
        /// Gets or sets the current specification.
        /// </summary>
        /// <value>
        /// The current specification.
        /// </value>
        public DamFailureMechanismeCalculationSpecification CurrentSpecification { get; set; }

        /// <summary>
        /// Gets or sets the calculation messages.
        /// </summary>
        /// <value>
        /// The calculation messages.
        /// </value>
        public List<LogMessage> CalculationMessages { get; set;}

        /// <summary>
        /// Gets or sets the kernel data input.
        /// </summary>
        /// <value>
        /// The kernel data input.
        /// </value>
        public Object KernelDataInput { get; set; }

        /// <summary>
        /// Gets or sets the kernel data output.
        /// </summary>
        /// <value>
        /// The kernel data output.
        /// </value>
        public Object KernelDataOutput { get; set; }

        /// <summary>
        /// Gets or sets the dam kernel input.
        /// </summary>
        /// <value>
        /// The dam kernel input.
        /// </value>
        public Object DamKernelInput { get; set; }

        /// <summary>
        /// Gets or sets the results.
        /// </summary>
        /// <value>
        /// The results.
        /// </value>
        public List<DesignResult> Results { get; set; }

        /// <summary>
        /// Gets or sets the HBP.
        /// </summary>
        /// <value>
        /// The HBP.
        /// </value>
        public double Hbp { get; set; }

        /// <summary>
        /// Gets or sets the LBP.
        /// </summary>
        /// <value>
        /// The LBP.
        /// </value>
        public double Lbp { get; set; }
    }
}