// 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 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 : GeometryPoint
    {
        private CharacteristicPointType characteristicPointType = CharacteristicPointType.None;
        private GeometryPoint geometryPoint;

        // 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, GeometryPoint point)
            : this()
        {
            PointSet = set;
            SetGeometryPoint(point);
        }

        /// <summary>
        ///     Gets or sets the characteristic type 'marker' of a geometry point on a surfaceline..
        /// </summary>
        public CharacteristicPointType CharacteristicPointType
        {
            get
            {
                return characteristicPointType;
            }
            set
            {
                characteristicPointType = value;
            }
        }

        /// <summary>
        ///     Gets or sets the geometry point.
        /// </summary>
        /// <value>
        ///     The geometry point.
        /// </value>
        public GeometryPoint GeometryPoint
        {
            get
            {
                return geometryPoint;
            }
            set
            {
                SetGeometryPoint(value);                
            }
        }

        /// <summary>
        ///     Gets or sets the characteristic point set associated containing this point.
        /// </summary>
        public CharacteristicPointSet PointSet { get; set; }

        /// <summary>
        ///     Gets or sets the X coordinate of GeometryPoint
        /// </summary>
        [Translation("L")]
        public override double X
        {
            get
            {
                return GeometryPoint.X;
            }
            set
            {
                if (GeometryPoint != null)
                {
                    GeometryPoint.X = value;
                }
            }
        }

        /// <summary>
        ///     Gets or sets the Z coordinate of GeometryPoint
        /// </summary>
        public override double Z
        {
            get
            {
                return GeometryPoint.Z;
            }
            set
            {
                if (GeometryPoint != null)
                {
                    GeometryPoint.Z = value;
                }
            }
        }

        /// <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());
        }

        private void SetGeometryPoint(GeometryPoint point)
        {
            geometryPoint = point;            
        }        
    }
}