// 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;
using System.Collections.Generic;
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Standard.Language;
using Deltares.DamEngine.Data.Standard.Validation;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary>
    /// Soil Layer object
    /// </summary>
    public class SoilLayer : GeometryObject
    {
        /// <summary>
        /// Gets or sets the soil object
        /// </summary>
        /// <exception cref="ArgumentNullException">soil value</exception>
        public virtual Soil Soil { get; set; }

        /// <summary>
        /// Defines whether the layer acts as aquifer (true) or aquitard (false).
        /// </summary>
        public virtual bool IsAquifer { get; set; }



        /// <summary>
        /// Gets or sets the waterpressure interpolation model.
        /// </summary>
        /// <value>
        /// The waterpressure interpolation model.
        /// </value>
        public virtual WaterpressureInterpolationModel WaterpressureInterpolationModel { get; set; }


        /// <summary>
        /// Validates the layer.
        /// </summary>
        /// <returns></returns>
        [Validate]
        public ValidationResult[] ValidateLayer()
        {
            var results = new List<ValidationResult>();
            {
                if (Soil == null)
                {
                    results.Add(new ValidationResult(ValidationResultType.Error, LocalizationManager.GetTranslatedText(GetType(), "NoSoilAssigned"), this));
                }
            }
            return results.ToArray();
        }
    }
}