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

namespace Deltares.DamEngine.Calculators.RegionalAssessment.Evaluator
{
    /// <summary>
    /// Evaluates whether the dike dry sensitivity is dry or none depending on the dikematerial type.
    /// </summary>
    /// <seealso cref="Deltares.DamEngine.Calculators.RegionalAssessment.Evaluator.Evaluator" />
    public class DikeMaterialEvaluator : Evaluator
    {
        /// <summary>
        /// Evaluates the specified a location.
        /// </summary>
        /// <param name="aLocation">a location.</param>
        /// <param name="aSoilGeometry">a soil geometry.</param>
        /// <param name="previousChoices">The previous choices.</param>
        /// <returns>Dry when dike material type is peat, else none</returns>
        public override Enum Evaluate(Location aLocation, SoilGeometry aSoilGeometry, params Enum[] previousChoices)
        {
            base.Evaluate(aLocation, aSoilGeometry, previousChoices);

            if (aLocation.DikeMaterialType == SoilType.Peat)
            {
                return DikeDrySensitivity.Dry;
            }
            else
            {
                return DikeDrySensitivity.None;
            }
        }
    }
}