// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets 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;
using System.Collections.Generic;
using System.Linq;
using Core.Common.Base.Data;
using Core.Common.Base.Geometry;
using Ringtoets.Common.Data.Properties;

namespace Ringtoets.Common.Data.DikeProfiles
{
    /// <summary>
    /// Definition for a dike profile for a failure mechanism.
    /// </summary>
    public class DikeProfile
    {
        /// <summary>
        /// Creates a new instance of the <see cref="DikeProfile"/> class.
        /// </summary>
        /// <param name="worldCoordinate">The value for <see cref="WorldReferencePoint"/>.</param>
        /// <param name="dikeGeometry">The geometry of the dike.</param>
        /// <param name="foreshoreGeometry">The geometry of the dike foreshore.</param>
        /// <param name="breakWater">The break water definition (can be null).</param>
        /// <param name="properties">The property values required to create an instance of <see cref="DikeProfile"/>.</param>
        /// <exception cref="ArgumentNullException">Thrown when either <paramref name="dikeGeometry"/>,
        /// <paramref name="foreshoreGeometry"/>, <paramref name="worldCoordinate"/> or 
        /// <paramref name="properties"/> is <c>null</c>.</exception>
        /// <exception cref="ArgumentException">Thrown when any element of <paramref name="dikeGeometry"/>
        /// or <paramref name="foreshoreGeometry"/> is <c>null</c>.</exception>
        public DikeProfile(Point2D worldCoordinate, IEnumerable<RoughnessPoint> dikeGeometry, IEnumerable<Point2D> foreshoreGeometry,
                           BreakWater breakWater, ConstructionProperties properties)
        {
            if (properties == null)
            {
                throw new ArgumentNullException("properties");
            }

            ForeshoreProfile = new ForeshoreProfile(worldCoordinate, foreshoreGeometry, breakWater, 
                                                    new ForeshoreProfile.ConstructionProperties
                                                    {
                                                        Name = properties.Name,
                                                        Orientation = properties.Orientation,
                                                        X0 = properties.X0
                                                    });

            SetGeometry(dikeGeometry);
            DikeHeight = new RoundedDouble(2, properties.DikeHeight);
        }

        /// <summary>
        /// Gets the foreshore profile.
        /// </summary>
        public ForeshoreProfile ForeshoreProfile { get; private set; }

        /// <summary>
        /// Gets the name of the dike profile.
        /// </summary>
        public string Name {
            get
            {
                return ForeshoreProfile.Name;
            }
        }

        /// <summary>
        /// Gets the reference point in world coordinates corresponding to the local coordinate <see cref="X0"/>.
        /// </summary>
        public Point2D WorldReferencePoint
        {
            get
            {
                return ForeshoreProfile.WorldReferencePoint;
            }
        }

        /// <summary>
        /// Gets the local x-coordinate corresponding to the world reference point <see cref="WorldReferencePoint"/>.
        /// </summary>
        public double X0
        {
            get
            {
                return ForeshoreProfile.X0;
            }
        }

        /// <summary>
        /// Gets or the orientation of the dike profile geometry with respect to North
        /// in degrees. A positive value equals a clockwise rotation.
        /// </summary>
        public RoundedDouble Orientation
        {
            get
            {
                return ForeshoreProfile.Orientation;
            }
        }

        /// <summary>
        /// Indicates if there is a break water object available for this instance or not.
        /// </summary>
        public bool HasBreakWater
        {
            get
            {
                return BreakWater != null;
            }
        }

        /// <summary>
        /// Gets the break water object of the dike profile, if any.
        /// </summary>
        public BreakWater BreakWater
        {
            get
            {
                return ForeshoreProfile.BreakWater;
            }
        }

        /// <summary>
        /// Gets the geometry of the foreshore.
        /// </summary>
        public RoundedPoint2DCollection ForeshoreGeometry
        {
            get
            {
                return ForeshoreProfile.Geometry;
            }
        }

        /// <summary>
        /// Gets the geometry of the dike with roughness data.
        /// </summary>
        /// <remarks>
        /// The roughness of a <see cref="RoughnessPoint"/> in the list represents
        /// the roughness of the section between this <see cref="RoughnessPoint"/>
        /// and the succeeding <see cref="RoughnessPoint"/>. The roughness of the last
        /// point is irrelevant.
        /// </remarks>
        public RoughnessPoint[] DikeGeometry { get; private set; }

        /// <summary>
        /// Gets or sets the height of the dike [m+NAP].
        /// </summary>
        public RoundedDouble DikeHeight { get; private set; }

        public override string ToString()
        {
            return Name;
        }

        private void SetGeometry(IEnumerable<RoughnessPoint> points)
        {
            if (points == null)
            {
                throw new ArgumentNullException("points", Resources.DikeProfile_SetGeometry_Collection_of_points_for_geometry_is_null);
            }

            var roughnessPoints = points.ToArray();
            if (roughnessPoints.Any(p => p == null))
            {
                throw new ArgumentException(Resources.DikeProfile_SetGeometry_A_point_in_the_collection_is_null);
            }

            DikeGeometry = roughnessPoints;
        }

        /// <summary>
        /// Class holding the various construction parameters for <see cref="DikeProfile"/>.
        /// </summary>
        public class ConstructionProperties
        {
            /// <summary>
            /// Gets or sets the value for <see cref="DikeProfile.Name"/>.
            /// </summary>
            public string Name { get; set; }

            /// <summary>
            /// Gets or sets the value for <see cref="DikeProfile.X0"/>.
            /// </summary>
            public double X0 { get; set; }

            /// <summary>
            /// Gets or sets the value for <see cref="DikeProfile.Orientation"/>.
            /// </summary>
            public double Orientation { get; set; }

            /// <summary>
            /// Gets or sets the value for <see cref="DikeProfile.DikeHeight"/>.
            /// </summary>
            /// <remark><paramref name="value"/> will be rounded to the <see cref="RoundedDouble.NumberOfDecimalPlaces"/>
            ///  of <see cref="DikeProfile.DikeHeight"/>.</remark>
            public double DikeHeight { get; set; }
        }
    }
}