// Copyright (C) Stichting Deltares 2017. 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 Core.Common.Base;
using Core.Common.Base.Data;
using Core.Common.Base.Geometry;
using Ringtoets.Common.Data.Hydraulics;

namespace Ringtoets.DuneErosion.Data
{
    /// <summary>
    /// Location of a dune.
    /// </summary>
    public class DuneLocation : Observable
    {
        /// <summary>
        /// Creates a new instance of <see cref="DuneLocation"/>.
        /// </summary>
        /// <param name="id">Id of the <see cref="DuneLocation"/>.</param>
        /// <param name="name">Name of the <see cref="DuneLocation"/>.</param>
        /// <param name="location">The coordinate of the <see cref="DuneLocation"/>.</param>
        /// <param name="properties">The container of the properties for the
        /// <see cref="DuneLocation"/></param>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/>
        /// or <paramref name="properties"/> is <c>null</c>.</exception>
        public DuneLocation(long id, string name, Point2D location, ConstructionProperties properties)
        {
            if (name == null)
            {
                throw new ArgumentNullException(nameof(name));
            }
            if (properties == null)
            {
                throw new ArgumentNullException(nameof(properties));
            }

            Id = id;
            Name = name;
            Location = location;
            CoastalAreaId = properties.CoastalAreaId;
            Offset = new RoundedDouble(1, properties.Offset);
            Orientation = new RoundedDouble(1, properties.Orientation);
            D50 = new RoundedDouble(6, properties.D50);
        }

        /// <summary>
        /// Gets the database id of the dune location.
        /// </summary>
        public long Id { get; private set; }

        /// <summary>
        /// Gets the name of the dune location.
        /// </summary>
        public string Name { get; private set; }

        /// <summary>
        /// Gets the coordinate of the dune location.
        /// </summary>
        public Point2D Location { get; private set; }

        /// <summary>
        /// Gets the coastal area id of the dune location.
        /// </summary>
        public int CoastalAreaId { get; private set; }

        /// <summary>
        /// Gets the offset of the dune location.
        /// </summary>
        public RoundedDouble Offset { get; private set; }

        /// <summary>
        /// Gets the orientation of the dune location.
        /// </summary>
        public RoundedDouble Orientation { get; private set; }

        /// <summary>
        /// Gets the d50 of the dune location.
        /// </summary>
        public RoundedDouble D50 { get; private set; }

        /// <summary>
        /// Gets or sets the output of a dune erosion calculation.
        /// </summary>
        public DuneLocationOutput Output { get; set; }

        /// <summary>
        /// Gets the convergence status of the dune erosion calculation.
        /// </summary>
        public CalculationConvergence CalculationConvergence
        {
            get
            {
                return Output?.CalculationConvergence ?? CalculationConvergence.NotCalculated;
            }
        }

        /// <summary>
        /// Class holding the various construction parameters for <see cref="DuneLocation"/>.
        /// </summary>
        public class ConstructionProperties
        {
            /// <summary>
            /// Sets the coastal area id of the dune location.
            /// </summary>
            public int CoastalAreaId { internal get; set; }

            /// <summary>
            /// Sets the offset of the dune location.
            /// </summary>
            public double Offset { internal get; set; }

            /// <summary>
            /// Sets the orientation of the dune location.
            /// </summary>
            public double Orientation { internal get; set; }

            /// <summary>
            /// Sets the d50 of the dune location.
            /// </summary>
            public double D50 { internal get; set; }
        }
    }
}