// 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 System.Collections.Generic;

namespace Ringtoets.HydraRing.Calculation.Data.Input.Hydraulics
{
    /// <summary>
    /// Container of all data necessary for performing a wave height calculation via Hydra-Ring.
    /// </summary>
    public class WaveHeightCalculationInput : ReliabilityIndexCalculationInput
    {
        private readonly HydraRingSection section;

        /// <summary>
        /// Creates a new instance of the <see cref="WaveHeightCalculationInput"/> class.
        /// </summary>
        /// <param name="sectionId">The id of the section.</param>
        /// <param name="hydraulicBoundaryLocationId">The id of the hydraulic boundary location.</param>
        /// <param name="returnPeriod">The return period.</param>
        public WaveHeightCalculationInput(int sectionId, long hydraulicBoundaryLocationId, double returnPeriod)
            : base(hydraulicBoundaryLocationId, returnPeriod)
        {
            section = new HydraRingSection(sectionId, double.NaN, double.NaN);
        }

        public override HydraRingFailureMechanismType FailureMechanismType
        {
            get
            {
                return HydraRingFailureMechanismType.WaveHeight;
            }
        }

        public override int VariableId
        {
            get
            {
                return 28;
            }
        }

        public override HydraRingSection Section
        {
            get
            {
                return section;
            }
        }

        public override IEnumerable<HydraRingVariable> Variables
        {
            get
            {
                yield return new HydraRingVariable(28, HydraRingDistributionType.Deterministic, 0,
                                                   HydraRingDeviationType.Standard, double.NaN, double.NaN, double.NaN);
            }
        }
    }
}