// Copyright (C) Stichting Deltares 2019. 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.Geotechnics;

namespace Deltares.DamEngine.Data.General
{
    /// <summary>
    /// Class holding the soilprofile (either 1D or 2D) and its probability
    /// </summary>
    public class SoilGeometryProbability
    {
        /// <summary>
        /// Gets or sets the name of the SoilProfile1D.
        /// </summary>
        /// <value>
        /// The name of the soilgeometry1d.
        /// </value>
        public virtual string SoilProfile1DName { get; set; }

        /// <summary>
        /// Gets or sets the soil profile 1D.
        /// </summary>
        /// <value>
        /// The soil profile.
        /// </value>
        public virtual SoilProfile1D SoilProfile1D { get; set; }

        /// <summary>
        /// Gets or sets the name of the SoilProfile2D.
        /// </summary>
        /// <value>
        /// The name of the soilgeometry1d.
        /// </value>
        public virtual string SoilProfile2DName { get; set; }

        /// <summary>
        /// Gets or sets the soilprofile2d.
        /// </summary>
        /// <value>
        /// The soilprofile2d.
        /// </value>
        public virtual SoilProfile2D SoilProfile2D { get; set; }

        /// <summary>
        /// Gets or sets the name of the sti file (that holds the 2D profile) including full path.
        /// </summary>
        /// <value>
        /// The name of the soilgeometry2d including full path.
        /// </value>

        public virtual string FullStiFileName { get; set; }

        /// <summary>
        /// Gets or sets the name of the sti file (that holds the 2D profile).
        /// </summary>
        /// <value>
        /// The name of the soilgeometry2d.
        /// </value>

        public virtual string StiFileName { get; set; }

        /// <summary>
        /// Gets or sets the type of the segment failure mechanism.
        /// </summary>
        /// <value>
        /// The type of the segment failure mechanism.
        /// </value>
        public virtual SegmentFailureMechanismType? SegmentFailureMechanismType { get; set; }

        /// <summary>
        /// Gets or sets the probability of occurance; number between 0.0 and 100.0.
        /// </summary>
        /// <value>
        /// The probability.
        /// </value>
        public virtual double Probability { get; set; }

        /// <summary>
        /// Gets the type of the soil geometry.
        /// </summary>
        /// <value>
        /// The type of the soil geometry.
        /// </value>
        /// <exception cref="System.Exception">No soilprofile assigned</exception>
        public SoilProfileType SoilProfileType { 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()
        {
            if (SoilProfile1D != null)
            {
                return SoilProfile1D.Name;
            }
            else
            {
                return StiFileName;
            }
        }
    }

}