// 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 Deltares.DamEngine.Data.Geotechnics;

namespace Deltares.DamEngine.Data.General.Results
{
    /// <summary>
    /// Class holding the results for the Stability design calculation
    /// </summary>
    public class StabilityDesignResults
    {
        private int? numberOfIterations;
        private string resultMessage = "";
        private double? safetyFactor;
        private double? zone1SafetyFactor;
        private double? localZone1EntryPointX;
        private double? localZone1ExitPointX;
        private double? zone2SafetyFactor;
        private double? localZone2EntryPointX;
        private double? localZone2ExitPointX;
        private UpliftSituation? upliftSituation;
        private SurfaceLine2 redesignedSurfaceLine;
        private MStabModelType? stabilityModelType;

        /// <summary>
        /// Gets or sets the number of iterations.
        /// </summary>
        /// <value>
        /// The number of iterations.
        /// </value>
        public int? NumberOfIterations
        {
            get
            {
                return numberOfIterations;
            }
            set
            {
                numberOfIterations = value;
            }
        }

        /// <summary>
        /// Gets or sets the result message.
        /// </summary>
        /// <value>
        /// The result message.
        /// </value>
        public string ResultMessage
        {
            get
            {
                return resultMessage;
            }
            set
            {
                resultMessage = value;
            }
        }

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

        /// <summary>
        /// Gets or sets the zone1 safety factor stability.
        /// </summary>
        /// <value>
        /// The zone1 safety factor stability.
        /// </value>
        public double? Zone1SafetyFactor
        {
            get
            {
                return zone1SafetyFactor;
            }
            set
            {
                zone1SafetyFactor = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone1 entry point x.
        /// </summary>
        /// <value>
        /// The local zone1 entry point x.
        /// </value>
        public double? LocalZone1EntryPointX
        {
            get
            {
                return localZone1EntryPointX;
            }
            set
            {
                localZone1EntryPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone1 exit point x.
        /// </summary>
        /// <value>
        /// The local zone1 exit point x.
        /// </value>
        public double? LocalZone1ExitPointX
        {
            get
            {
                return localZone1ExitPointX;
            }
            set
            {
                localZone1ExitPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the zone2 safety factor stability.
        /// </summary>
        /// <value>
        /// The zone2 safety factor stability.
        /// </value>
        public double? Zone2SafetyFactor
        {
            get
            {
                return zone2SafetyFactor;
            }
            set
            {
                zone2SafetyFactor = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone2 entry point x.
        /// </summary>
        /// <value>
        /// The local zone2 entry point x.
        /// </value>
        public double? LocalZone2EntryPointX
        {
            get
            {
                return localZone2EntryPointX;
            }
            set
            {
                localZone2EntryPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the local zone2 exit point x.
        /// </summary>
        /// <value>
        /// The local zone2 exit point x.
        /// </value>
        public double? LocalZone2ExitPointX
        {
            get
            {
                return localZone2ExitPointX;
            }
            set
            {
                localZone2ExitPointX = value;
            }
        }

        /// <summary>
        /// Gets or sets the uplift situation.
        /// </summary>
        /// <value>
        /// The uplift situation.
        /// </value>
        public UpliftSituation? UpliftSituation
        {
            get
            {
                return upliftSituation;
            }
            set
            {
                upliftSituation = value;
            }
        }

        /// <summary>
        /// Gets or sets the redesigned surface line stability.
        /// </summary>
        /// <value>
        /// The redesigned surface line stability.
        /// </value>
        public SurfaceLine2 RedesignedSurfaceLine
        {
            get
            {
                return redesignedSurfaceLine;
            }
            set
            {
                redesignedSurfaceLine = value;
            }
        }
        
        /// <summary>
        /// Gets or sets the type of the stability model.
        /// </summary>
        /// <value>
        /// The type of the stability model.
        /// </value>
        public MStabModelType? StabilityModelType
        {
            get
            {
                return stabilityModelType;
            }
            set
            {
                stabilityModelType = value;
            }
        }

    }
}