// 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;
using System.Xml;
using Ringtoets.Common.IO.Writers;

namespace Ringtoets.ClosingStructures.IO
{
    /// <summary>
    /// Writer for writing <see cref="ClosingStructuresCalculationConfiguration"/> in XML format to file.
    /// </summary>
    public class ClosingStructuresCalculationConfigurationWriter : StructureCalculationConfigurationWriter<ClosingStructuresCalculationConfiguration>
    {
        /// <summary>
        /// Creates a new instance of <see cref="ClosingStructuresCalculationConfigurationWriter"/>.
        /// </summary>
        /// <param name="filePath">The path of the file to write to.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="filePath"/> is invalid.</exception>
        /// <remarks>A valid path:
        /// <list type="bullet">
        /// <item>is not empty or <c>null</c>,</item>
        /// <item>does not consist out of only whitespace characters,</item>
        /// <item>does not contain an invalid character,</item>
        /// <item>does not end with a directory or path separator (empty file name).</item>
        /// </list></remarks>
        public ClosingStructuresCalculationConfigurationWriter(string filePath)
            : base(filePath) {}

        protected override void WriteSpecificStructureParameters(ClosingStructuresCalculationConfiguration configuration, XmlWriter writer)
        {
            if (configuration.InflowModelType != null)
            {
                writer.WriteElementString(
                    ClosingStructuresConfigurationSchemaIdentifiers.InflowModelType,
                    new ConfigurationClosingStructureInflowModelTypeConverter().ConvertToInvariantString(configuration.InflowModelType));
            }

            WriteElementWhenContentAvailable(writer,
                                             ClosingStructuresConfigurationSchemaIdentifiers.FactorStormDurationOpenStructure,
                                             configuration.FactorStormDurationOpenStructure);
            WriteElementWhenContentAvailable(writer,
                                             ClosingStructuresConfigurationSchemaIdentifiers.IdenticalApertures,
                                             configuration.IdenticalApertures);
            WriteElementWhenContentAvailable(writer,
                                             ClosingStructuresConfigurationSchemaIdentifiers.ProbabilityOrFrequencyOpenStructureBeforeFlooding,
                                             configuration.ProbabilityOrFrequencyOpenStructureBeforeFlooding);
            WriteElementWhenContentAvailable(writer,
                                             ClosingStructuresConfigurationSchemaIdentifiers.FailureProbabilityOpenStructure,
                                             configuration.FailureProbabilityOpenStructure);
            WriteElementWhenContentAvailable(writer,
                                             ClosingStructuresConfigurationSchemaIdentifiers.FailureProbabilityReparation,
                                             configuration.FailureProbabilityReparation);
        }

        protected override void WriteSpecificStochasts(ClosingStructuresCalculationConfiguration configuration, XmlWriter writer)
        {
            WriteDistributionWhenAvailable(writer,
                                           ClosingStructuresConfigurationSchemaIdentifiers.DrainCoefficientStochastName,
                                           configuration.DrainCoefficient);
            WriteDistributionWhenAvailable(writer,
                                           ClosingStructuresConfigurationSchemaIdentifiers.InsideWaterLevelStochastName,
                                           configuration.InsideWaterLevel);
            WriteDistributionWhenAvailable(writer,
                                           ClosingStructuresConfigurationSchemaIdentifiers.AreaFlowAperturesStochastName,
                                           configuration.AreaFlowApertures);
            WriteDistributionWhenAvailable(writer,
                                           ClosingStructuresConfigurationSchemaIdentifiers.ThresholdHeightOpenWeirStochastName,
                                           configuration.ThresholdHeightOpenWeir);
            WriteDistributionWhenAvailable(writer,
                                           ClosingStructuresConfigurationSchemaIdentifiers.LevelCrestStructureNotClosingStochastName,
                                           configuration.LevelCrestStructureNotClosing);
        }
    }
}