// Copyright (C) Stichting Deltares 2017. 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 System.Collections.Generic;
using System.Linq;
using Deltares.DamEngine.Data.Geometry;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary>
    /// All extension-methods for <see cref="SurfaceLine2"/>.
    /// </summary>
    public static class SurfaceLine2Extensions
    {
        /// <summary>
        /// Returns all <see cref="CharacteristicPoint"/> that require to be sorted on X
        /// ascending.
        /// </summary>
        /// <param name="line">The evaluated surfaceline.</param>
        /// <returns>Collection of characteristic points, ordered by type from the point
        /// expecting the lowest X coordinate in the set through to the one expecting the
        /// highest X coordinate.</returns>
        public static IEnumerable<CharacteristicPoint> GetCharacteristicPointsRequiringAscendingX(this SurfaceLine2 line)
        {
            return line.CharacteristicPoints.Where(p =>
                                                   !double.IsNaN(p.X) && // Note: This probably shall no longer apply to SurfaceLine2
                                                   p.CharacteristicPointType != CharacteristicPointType.None &&
                                                   p.CharacteristicPointType != CharacteristicPointType.TrafficLoadInside &&
                                                   p.CharacteristicPointType != CharacteristicPointType.TrafficLoadOutside).
                        OrderBy(p => p.CharacteristicPointType);
        }

        /// <summary>
        /// Checks whether the specified line has the given annotation.
        /// </summary>
        /// <param name="line">The surface line to be checked.</param>
        /// <param name="type">The type.</param>
        /// <returns></returns>
        /// <seealso cref="IsDefined"/>
        public static bool HasAnnotation(this SurfaceLine2 line, CharacteristicPointType type)
        {
            return line.CharacteristicPoints.GetGeometryPoint(type) != null;
        }

        /// <summary>
        /// Determines whether the specified characteristic point type is defined (has 
        /// the given annotation and its X coordinate is not <see cref="double.NaN"/>).
        /// </summary>
        /// <param name="line">The evaluated surfaceline.</param>
        /// <param name="characteristicPointType">Type of the characteristic point.</param>
        /// <returns>true if input parameter is defined</returns>
        /// <seealso cref="HasAnnotation"/>
        public static bool IsDefined(this SurfaceLine2 line, CharacteristicPointType characteristicPointType)
        {
            // TODO: GRASP: Information Expert -> CharacteristicPoint class should be responsible for this logic.
            return line.HasAnnotation(characteristicPointType) &&
                   !Double.IsNaN(line.CharacteristicPoints.GetGeometryPoint(characteristicPointType).X);
        }

        /// <summary>
        /// Gets the absolute height ([m]) of the dike.
        /// </summary>
        /// <returns>Height of dike, or null if <see cref="CharacteristicPointType.DikeTopAtRiver"/>
        /// is not defined for the surface line.</returns>
        public static double? GetDikeHeight(this SurfaceLine2 line)
        {
            var dikeTopAtRiver = line.CharacteristicPoints.GetGeometryPoint(CharacteristicPointType.DikeTopAtRiver);
            if (dikeTopAtRiver != null)
            {
                return dikeTopAtRiver.Z;
            }
            return null;
        }

        /// <summary>
        /// If shoulder is present then the toe of the shoulder (<see cref="CharacteristicPointType.DikeToeAtPolder"/>) 
        /// is returned, else the toe of the dike (<see cref="CharacteristicPointType.ShoulderBaseInside"/>)
        /// is returned.
        /// </summary>
        /// <returns>Toe of the dike, or null if none of the required characteristic 
        /// annotations can be found.</returns>
        public static GeometryPoint GetDikeToeInward(this SurfaceLine2 line)
        {
            return line.CharacteristicPoints.GetGeometryPoint(CharacteristicPointType.ShoulderBaseInside) ??
                   line.CharacteristicPoints.GetGeometryPoint(CharacteristicPointType.DikeToeAtPolder);
        }

        /// <summary>
        /// Gets the length of the dike.
        /// </summary>
        /// <returns>dike length or null in case toe points are null</returns>
        public static double? GetDikeLength(this SurfaceLine2 line)
        {
            var dikeToeAtRiver = line.CharacteristicPoints.GetGeometryPoint(CharacteristicPointType.DikeToeAtRiver);
            var dikeToeAtPolder = line.CharacteristicPoints.GetGeometryPoint(CharacteristicPointType.DikeToeAtPolder);

            if (dikeToeAtRiver != null && dikeToeAtPolder != null)
            {
                return Math.Abs(dikeToeAtRiver.X - dikeToeAtPolder.X);
            }
            return null;
        }

        /// <summary>
        /// Checks if a surfaceline has all characteristic point types required to describe
        /// a dike.
        /// </summary>
        /// <param name="line">Surfaceline to be checked.</param>
        /// <returns>True if there are characteristic points defined that describe a dike;
        /// False otherwise.</returns>
        public static bool HasDike(this SurfaceLine2 line)
        {
            return IsDefined(line, CharacteristicPointType.DikeToeAtRiver) &&
                   IsDefined(line, CharacteristicPointType.DikeTopAtRiver) &&
                   IsDefined(line, CharacteristicPointType.DikeTopAtPolder) &&
                   IsDefined(line, CharacteristicPointType.DikeToeAtPolder);
        }
    }
}