// Copyright (C) Stichting Deltares 2018. All rights reserved.
//
// This file is part of the application DAM - Clients Library.
//
// DAM - UI is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU 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.Standard.Specifications
{
    /// <summary>
    /// Checks if the candidate is in between the range boundaries. Boundaries are excluded
    /// </summary>
    public class InBetweenRangeSpecification : SpecificationBase<double>
    {
        private readonly double min;
        private readonly double max;

        public InBetweenRangeSpecification(double min, double max)
        {
            this.min = min;
            this.max = max;

            Name = "In between range specification";
            Description = string.Format("The candidate value should have a value between {0} and {1}. Boundaries are excluded", min, max);
        }

        /// <summary>
        /// Determines whether the candidate satisfies the specification.
        /// </summary>
        /// <param name="candidate">The candidate to test.</param>
        /// <returns>
        ///   <c>true</c> if the candidate satisfies the specification otherwise, <c>false</c>.
        /// </returns>
        public override bool IsSatisfiedBy(double candidate)
        {
            return (min < candidate && max > candidate);
        }
    }

}