// 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.

namespace Deltares.DamEngine.Data.General
{
    public class StabilityOptions
    {
        private double? forbiddenZoneFactor = 1.0;
        private double? zoneAreaRestSlopeCrestWidth = 3.0;
        private double? minimalCircleDepth = 0;
        private double? trafficLoad = 0;
        private double? trafficLoadDegreeOfConsolidation;

        /// <summary>
        /// Gets or sets the map for soilgeometries2d (sti-files).
        /// </summary>
        /// <value>
        /// The map for soilgeometries2d.
        /// </value>
        public string SoilGeometries2DPath { get; set; } = "";

        /// <summary>
        /// Gets or sets the name of the soil database.
        /// </summary>
        /// <value>
        /// The name of the soil database.
        /// </value>
        public string SoilDatabaseName { get; set; } = "";

        /// <summary>
        /// Gets or sets the type of the stability zone.
        /// </summary>
        /// <value>
        /// The type of the stability zone.
        /// </value>
        public MStabZonesType StabilityZoneType { get; set; } = MStabZonesType.NoZones;

        /// <summary>
        /// Gets or sets the forbidden zone factor.
        /// </summary>
        /// <value>
        /// The forbidden zone factor.
        /// </value>
        public double? ForbiddenZoneFactor
        {
            get
            {
                return forbiddenZoneFactor;
            }
            set
            {
                forbiddenZoneFactor = value;
            }
        }

        /// <summary>
        /// Gets or sets the width of the zone area rest slope crest.
        /// </summary>
        /// <value>
        /// The width of the zone area rest slope crest.
        /// </value>
        public double? ZoneAreaRestSlopeCrestWidth
        {
            get
            {
                return zoneAreaRestSlopeCrestWidth;
            }
            set
            {
                zoneAreaRestSlopeCrestWidth = value;
            }
        }

        /// <summary>
        /// Gets or sets the traffic load.
        /// </summary>
        /// <value>
        /// The traffic load.
        /// </value>
        public double? TrafficLoad

        {
            get
            {
                return trafficLoad;
            }
            set
            {
                trafficLoad = value;
            }
        }

        /// <summary>Gets or sets the degree of consolidation for the traffic load.</summary>
        /// <value>The degree of consolidation for traffic load.</value>
        public double? TrafficLoadDegreeOfConsolidation

        {
            get
            {
                return trafficLoadDegreeOfConsolidation;
            }
            set
            {
                trafficLoadDegreeOfConsolidation = value;
            }
        }

        /// <summary>
        /// Gets or sets the minimal circle depth.
        /// </summary>
        /// <value>
        /// The minimal circle depth.
        /// </value>
        public double? MinimalCircleDepth
        {
            get
            {
                return minimalCircleDepth;
            }
            set
            {
                minimalCircleDepth = value;
            }
        }        
    }

    
}