// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of the Macro Stability kernel.
//
// The Macro Stability kernel 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.Xml.Serialization;
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Standard.Language;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary> 
    /// Pre-consolidation stress used within preproces stability
    /// </summary>
    public class PreConsolidationStress : GeometryPoint
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="PreConsolidationStress"/> class
        /// as a XZ point.
        /// </summary>
        public PreConsolidationStress()
        {
            StressValue = double.NaN;
        }

        /// <summary>
        /// Gets or sets the stress value.
        /// </summary>
        [XmlIgnore]
        public double StressValue { get; set; }

        /// <summary>
        /// Gets or sets the name.
        /// </summary>
        /// <value>
        /// The name.
        /// </value>
        public override string Name { get; set; }


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


        /// <summary>
        /// Gets or sets the Z coordinate of publisherEventArgs GeometryPoint
        /// </summary>
        [Translation("ZCoordYieldStress")]
        public override double Z
        {
            get
            {
                return base.Z;
            }
            set
            {
                base.Z = value;
            }
        }

        /// <summary>
        /// Clones this instance.
        /// </summary>
        public override object Clone()
        {
            var clone = new PreConsolidationStress
            {
                Name = Name,
                StressValue = StressValue,
                X = X,
                Z = Z
            };
            return clone;
        }
    }
}