// Copyright (C) Stichting Deltares 2018. All rights reserved.
//
// This file is part of the application DAM - UI.
//
// 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.

using System;

namespace Deltares.Standard.Specifications
{
    /// <summary>
    /// Defines a greater then of equal to specification
    /// </summary>
    /// <typeparam name="TCandidate">The type of the candidate.</typeparam>
    /// <typeparam name="TValue">The type of the value.</typeparam>
    public class GreaterThanOrEqualToSpecification<TCandidate, TValue> : ValueBoundSpecification<TCandidate, TValue> where TValue : IComparable
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="GreaterThanOrEqualToSpecification&lt;TCandidate, TValue&gt;"/> class.
        /// </summary>
        /// <param name="attributeName">Name of the attribute.</param>
        /// <param name="attributeValue">The attribute value.</param>
        public GreaterThanOrEqualToSpecification(string attributeName, TValue attributeValue)
            : base(attributeName, attributeValue)
        {
        }

        /// <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(TCandidate candidate)
        {
            var actual = this.GetCandidateTValue(candidate) as IComparable;
            return (actual.CompareTo(this.AttributeValue) >= 0);
        }
    }
}