// Copyright (C) Stichting Deltares 2024. 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 Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Standard.Language;

namespace Deltares.DamEngine.Data.Geotechnics;

/// <summary>
/// Represents a point on a surface line of a particular <seealso cref="CharacteristicPointType" />.
/// </summary>
/// <seealso cref="CharacteristicPointType" />
public class CharacteristicPoint : IComparable
{
    // Aggregation relationship

    /// <summary>
    /// Initializes a new instance of the <see cref="CharacteristicPoint" /> class.     
    /// </summary>
    public CharacteristicPoint()
    {
        //geometryPoint = new GeometryPoint();
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="CharacteristicPoint" /> class.
    /// </summary>
    /// <param name="set">The containing characteristic point set.</param>
    /// <param name="point">The geometry point.</param>
    public CharacteristicPoint(CharacteristicPointSet set, Point2D point)
        : this()
    {
        PointSet = set;
        Point = point;
    }

    /// <summary>
    /// Gets or sets the characteristic type 'marker' of a geometry point on a surface line.
    /// </summary>
    public CharacteristicPointType CharacteristicPointType { get; set; } = CharacteristicPointType.None;

    /// <summary>
    ///     Gets or sets the geometry point.
    /// </summary>
    /// <value>
    ///     The geometry point.
    /// </value>
    public Point2D Point { get; set; }

    /// <summary>
    /// Gets or sets the characteristic point set associated containing this point.
    /// </summary>
    public CharacteristicPointSet PointSet { get; set; }
    
    /// <summary>
    /// Returns a <see cref="System.String" /> that represents this instance.
    /// </summary>
    /// <returns>
    /// A <see cref="System.String" /> that represents this instance.
    /// </returns>
    public override string ToString()
    {
        return LocalizationManager.GetTranslatedText(GetType(), CharacteristicPointType.ToString());
    }

    /// <summary>
    /// Compares the Point of the object.
    /// </summary>
    /// <param name="obj"></param>
    /// <returns></returns>
    public int CompareTo(object obj)
    {
        var characteristicPoint = obj as CharacteristicPoint;
        if (characteristicPoint != null)
        {
            Point2D comparePoint = characteristicPoint.Point;

            if (comparePoint != null)
            {
                return Point.X.CompareTo(comparePoint.X);
            }
        }

        return string.Compare(ToString(), obj.ToString(), StringComparison.Ordinal);
    }
}