// 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.General.Specifications;

namespace Deltares.DamEngine.Data.General.Sensors.Specifications
{
    /// <summary>
    /// Class holding the DitchWaterLevelSensorSpecification
    /// </summary>
    /// <seealso cref="Deltares.DamEngine.Data.General.Specifications.PredicateSpecification{Deltares.DamEngine.Data.General.Sensors.Sensor}" />
    public class DitchWaterLevelSensorSpecification : PredicateSpecification<Sensor>
    {
        private readonly double xDitchDikeSide;
        private readonly double xDitchPolderSide;

        /// <summary>
        /// Initializes a new instance of the <see cref="DitchWaterLevelSensorSpecification"/> class.
        /// </summary>
        /// <param name="xDitchDikeSide">The x ditch dike side.</param>
        /// <param name="xDitchPolderSide">The x ditch polder side.</param>
        public DitchWaterLevelSensorSpecification(double xDitchDikeSide, double xDitchPolderSide) :
            base(s => s.SensorType == SensorType.PolderLevel)
        {
            this.xDitchDikeSide = xDitchDikeSide;
            this.xDitchPolderSide = xDitchPolderSide;
        }

        /// <summary>
        /// Determines whether the candidate satisfies the specification.
        /// </summary>
        /// <param name="candidate">The candidate.</param>
        /// <returns>
        /// <c>true</c> if the candidate satisfies the specification otherwise, <c>false</c>.
        /// </returns>
        public override bool IsSatisfiedBy(Sensor candidate)
        {
            if (base.IsSatisfiedBy(candidate))
                return true;

            return candidate.RelativeLocation > xDitchDikeSide && candidate.RelativeLocation < xDitchPolderSide;
        }
    }
}