// Copyright (C) Stichting Deltares 2018. 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.Collections.Generic;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.Standard.Calculation;

namespace Deltares.DamEngine.Data.RegionalAssessmentResults
{
    /// <summary>
    /// Class for results of one particular regional scenario
    /// </summary>
    public class RegionalScenarioResult
    {
        private LoadSituation loadSituation = LoadSituation.Wet;
        private DikeDrySensitivity dikeDrySensitivity = DikeDrySensitivity.None;
        private HydraulicShortcutType hydraulicShortcutType = HydraulicShortcutType.NoHydraulicShortcut;
        private UpliftType upliftType = UpliftType.NoUplift;
        private MStabModelType modelOption;
        private CalculationResult calculationResult = CalculationResult.NoRun;
        private ScenarioType scenarioType = ScenarioType.Scenario01;

        private IList<RegionalScenarioProfileResult> regionalScenarioProfileResults = new List<RegionalScenarioProfileResult>();

        /// <summary>
        /// Gets or sets the calculation result.
        /// </summary>
        /// <value>
        /// The calculation result.
        /// </value>
        public CalculationResult CalculationResult
        {
            get { return calculationResult; }
            set { calculationResult = value; }
        }

        /// <summary>
        /// Gets or sets the safety factor.
        /// </summary>
        /// <value>
        /// The safety factor.
        /// </value>
        public double SafetyFactor { get; set; }

        /// <summary>
        /// Gets the regional scenario profile results.
        /// </summary>
        /// <value>
        /// The regional scenario profile results.
        /// </value>
        public IList<RegionalScenarioProfileResult> RegionalScenarioProfileResults
        {
            get { return regionalScenarioProfileResults; }
            set { regionalScenarioProfileResults = value; }
        }

        /// <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 model option.
        /// </summary>
        /// <value>
        /// The model option.
        /// </value>
        public MStabModelType ModelOption
        {
            get { return modelOption; }
            set { modelOption = 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; }
        }
    }
}