// Copyright (C) Stichting Deltares 2017. 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;
using System.Collections.Generic;
using Ringtoets.Common.Data.Calculation;
using Ringtoets.Common.Data.DikeProfiles;
using Ringtoets.Common.IO.Configurations;
using Ringtoets.Common.IO.Configurations.Export;
using Ringtoets.Common.IO.Configurations.Helpers;
using Ringtoets.Revetment.Data;
using Ringtoets.Revetment.IO.Configurations.Helpers;

namespace Ringtoets.Revetment.IO.Configurations
{
    /// <summary>
    /// Base implementation of exporter to export a wave conditions calculation configuration and stores it as an XML file.
    /// </summary>
    /// <typeparam name="TWaveConditionsCalculationConfigurationWriter">The type of writer to use.</typeparam>
    /// <typeparam name="TWaveConditionsCalculationConfiguration">The type of calculation configuration to export.</typeparam>
    /// <typeparam name="TCalculation">The type of calculation to use.</typeparam>
    public abstract class WaveConditionsCalculationConfigurationExporter<TWaveConditionsCalculationConfigurationWriter, TWaveConditionsCalculationConfiguration, TCalculation>
        : CalculationConfigurationExporter<TWaveConditionsCalculationConfigurationWriter, TCalculation, TWaveConditionsCalculationConfiguration>
        where TWaveConditionsCalculationConfigurationWriter : CalculationConfigurationWriter<TWaveConditionsCalculationConfiguration>
        where TWaveConditionsCalculationConfiguration : WaveConditionsCalculationConfiguration
        where TCalculation : class, ICalculation<WaveConditionsInput>
    {
        /// <summary>
        /// Creates a new instance of <see cref="WaveConditionsCalculationConfigurationExporter{TWaveConditionsCalculationConfigurationWriter,TWaveConditionsCalculationConfiguration,TCalculation}"/>.
        /// </summary>
        /// <param name="calculations">The hierarchy of calculations to export.</param>
        /// <param name="filePath">The path of the XML file to export to.</param>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="calculations"/> is <c>null</c>.</exception>
        /// <exception cref="ArgumentException">Thrown when <paramref name="filePath"/> is invalid.</exception>
        protected WaveConditionsCalculationConfigurationExporter(IEnumerable<ICalculationBase> calculations, string filePath)
            : base(calculations, filePath) {}

        protected abstract override TWaveConditionsCalculationConfigurationWriter CreateWriter(string filePath);

        protected abstract override TWaveConditionsCalculationConfiguration ToConfiguration(TCalculation calculation);

        /// <summary>
        /// Converts a <see cref="WaveConditionsInput"/> to <see cref="WaveConditionsCalculationConfiguration"/>.
        /// </summary>
        /// <param name="calculation">The calculation to convert.</param>
        /// <returns>A new <see cref="WaveConditionsCalculationConfiguration"/> with values 
        /// taken from <paramref name="calculation"/>.</returns>
        protected WaveConditionsCalculationConfiguration CreateConfiguration(TCalculation calculation)
        {
            WaveConditionsInput input = calculation.InputParameters;
            var calculationConfiguration = new WaveConditionsCalculationConfiguration(calculation.Name)
            {
                HydraulicBoundaryLocationName = input.HydraulicBoundaryLocation?.Name,
                LowerBoundaryRevetment = input.LowerBoundaryRevetment,
                UpperBoundaryRevetment = input.UpperBoundaryRevetment,
                LowerBoundaryWaterLevels = input.LowerBoundaryWaterLevels,
                UpperBoundaryWaterLevels = input.UpperBoundaryWaterLevels,
                Orientation = input.Orientation,
                StepSize = (ConfigurationWaveConditionsInputStepSize?) new ConfigurationWaveConditionsInputStepSizeConverter().ConvertFrom(input.StepSize)
            };
            SetConfigurationForeshoreProfileDependendProperties(calculationConfiguration, input);
            return calculationConfiguration;
        }

        private static void SetConfigurationForeshoreProfileDependendProperties(WaveConditionsCalculationConfiguration configuration,
                                                                                WaveConditionsInput input)
        {
            if (input.ForeshoreProfile == null)
            {
                return;
            }

            configuration.ForeshoreProfileId = input.ForeshoreProfile?.Id;
            configuration.WaveReduction = new WaveReductionConfiguration
            {
                UseForeshoreProfile = input.UseForeshore,
                UseBreakWater = input.UseBreakWater,
                BreakWaterHeight = input.BreakWater.Height
            };

            if (Enum.IsDefined(typeof(BreakWaterType), input.BreakWater.Type))
            {
                configuration.WaveReduction.BreakWaterType = (ConfigurationBreakWaterType?)
                    new ConfigurationBreakWaterTypeConverter().ConvertFrom(input.BreakWater.Type);
            }
        }
    }
}