// Copyright (C) Stichting Deltares 2018. 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.Geometry;
using Ringtoets.Common.Data.DikeProfiles;

namespace Ringtoets.Common.Data.TestUtil
{
    /// <summary>
    /// Factory that creates simple <see cref="DikeProfile"/> instances
    /// which can be used for testing.
    /// </summary>
    public class DikeProfileTestFactory
    {
        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin.
        /// </summary>
        public static DikeProfile CreateDikeProfile()
        {
            return CreateDikeProfile(new Point2D(0, 0));
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin 
        /// with a specified name.
        /// </summary>
        /// <param name="name">The name of the dike profile.</param>
        public static DikeProfile CreateDikeProfile(string name)
        {
            return CreateDikeProfile(name, new Point2D(0, 0));
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin
        /// with a specified name and ID.
        /// </summary>
        /// <param name="name">The name of the dike profile.</param>
        /// <param name="id">The ID of the dike profile.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="id"/> is
        /// <c>null</c>, empty, or consists of whitespace. </exception>
        public static DikeProfile CreateDikeProfile(string name, string id)
        {
            return CreateDikeProfile(id, name, new Point2D(0, 0), Enumerable.Empty<RoughnessPoint>(), Enumerable.Empty<Point2D>());
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at a specified world 
        /// location.
        /// </summary>
        /// <param name="point">The world coordinate of the dike profile.</param>
        public static DikeProfile CreateDikeProfile(Point2D point)
        {
            return CreateDikeProfile(null, point);
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at a specified world 
        /// location and ID.
        /// </summary>
        /// <param name="point">The world coordinate of the dike profile.</param>
        /// <param name="id">The ID of the dike profile.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="id"/> is
        /// <c>null</c>, empty, or consists of whitespace. </exception>
        public static DikeProfile CreateDikeProfile(Point2D point, string id)
        {
            return CreateDikeProfile(id, "name", point, Enumerable.Empty<RoughnessPoint>(), Enumerable.Empty<Point2D>());
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin with 
        /// a specified foreshore profile geometry.
        /// </summary>
        /// <param name="foreshoreProfileGeometry">The geometry of the <see cref="ForeshoreProfile"/>.</param>
        public static DikeProfile CreateDikeProfile(IEnumerable<Point2D> foreshoreProfileGeometry)
        {
            return CreateDikeProfile("id", "name", new Point2D(0, 0), Enumerable.Empty<RoughnessPoint>(), foreshoreProfileGeometry);
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin with 
        /// a specified foreshore profile geometry and ID.
        /// </summary>
        /// <param name="foreshoreProfileGeometry">The geometry of the <see cref="ForeshoreProfile"/>.</param>
        /// <param name="id">The ID of the dike profile.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="id"/> is
        /// <c>null</c>, empty, or consists of whitespace. </exception>
        public static DikeProfile CreateDikeProfile(IEnumerable<Point2D> foreshoreProfileGeometry, string id)
        {
            return CreateDikeProfile(id, "name", new Point2D(0, 0), Enumerable.Empty<RoughnessPoint>(), foreshoreProfileGeometry);
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world origin with 
        /// a specified dike profile geometry.
        /// </summary>
        /// <param name="dikeGeometry">The geometry of the <see cref="ForeshoreProfile"/>.</param>
        public static DikeProfile CreateDikeProfile(IEnumerable<RoughnessPoint> dikeGeometry)
        {
            return CreateDikeProfile("id", "name", new Point2D(0, 0), dikeGeometry, Enumerable.Empty<Point2D>());
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/> at the world location.
        /// </summary>
        /// <param name="name">The name of the dike profile.</param>
        /// <param name="point">The world coordinate of the dike profile.</param>
        public static DikeProfile CreateDikeProfile(string name, Point2D point)
        {
            return CreateDikeProfile("id", name, point, Enumerable.Empty<RoughnessPoint>(), Enumerable.Empty<Point2D>());
        }

        /// <summary>
        /// Creates a default <see cref="DikeProfile"/>at the world location with 
        /// a specified foreshore profile geometry.
        /// </summary>
        /// <param name="id">The ID of the dike profile.</param>
        /// <param name="name">The name of the dike profile.</param>
        /// <param name="point">The world coordinate of the dike profile.</param>
        /// <param name="dikeGeometry">The geometry of the dike.</param>
        /// <param name="foreshoreProfileGeometry">The geometry of the <see cref="ForeshoreProfile"/>.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="id"/> is
        /// <c>null</c>, empty, or consists of whitespace. </exception>
        private static DikeProfile CreateDikeProfile(string id,
                                                     string name,
                                                     Point2D point,
                                                     IEnumerable<RoughnessPoint> dikeGeometry,
                                                     IEnumerable<Point2D> foreshoreProfileGeometry)
        {
            return new DikeProfile(point, dikeGeometry, foreshoreProfileGeometry, null, new DikeProfile.ConstructionProperties
            {
                Id = id,
                Name = name
            });
        }
    }
}