// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU 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 Ringtoets.Common.Data.AssessmentSection;

namespace Ringtoets.Common.IO
{
    /// <summary>
    /// This class represents settings that are defined at <see cref="IAssessmentSection"/>
    /// level.
    /// </summary>
    public class AssessmentSectionSettings
    {
        private AssessmentSectionSettings(string id, double n, bool isDune)
        {
            AssessmentSectionId = id;
            N = n;
            IsDune = isDune;
        }

        /// <summary>
        /// The 'length effect' parameter.
        /// </summary>
        public double N { get; private set; }

        /// <summary>
        /// Gets a value indicating whether this instance is a dune assessment section or not.
        /// </summary>
        public bool IsDune { get; private set; }

        /// <summary>
        /// Gets the assessment section identifier, that can be used to match to <see cref="IAssessmentSection.Name"/>.
        /// </summary>
        public string AssessmentSectionId { get; private set; }

        /// <summary>
        /// Creates the settings for a dike assessment section.
        /// </summary>
        /// <param name="id">The identifier of the assessment section.</param>
        /// <param name="n">The 'length effect' parameter.</param>
        /// <returns>A fully configured <see cref="AssessmentSectionSettings"/>.</returns>
        public static AssessmentSectionSettings CreateDikeAssessmentSectionSettings(string id, double n)
        {
            return new AssessmentSectionSettings(id, n, false);
        }

        /// <summary>
        /// Creates the settings for a dune assessment section.
        /// </summary>
        /// <param name="id">The identifier of the assessment section.</param>
        /// <returns>A fully configured <see cref="AssessmentSectionSettings"/>.</returns>
        public static AssessmentSectionSettings CreateDuneAssessmentSectionSettings(string id)
        {
            return new AssessmentSectionSettings(id, 3.0, true);
        }
    }
}