// 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 Core.Common.Base.Data;
using Core.Common.Base.Service;
using Core.Common.Utils;
using log4net;
using Ringtoets.Common.Service.MessageProviders;
using Ringtoets.HydraRing.Calculation.Activities;
using Ringtoets.HydraRing.Calculation.Data.Output;
using Ringtoets.HydraRing.Data;

namespace Ringtoets.Common.Service
{
    /// <summary>
    /// <see cref="Activity"/> for running a design water level calculation.
    /// </summary>
    public class DesignWaterLevelCalculationActivity : HydraRingActivity<ReliabilityIndexCalculationOutput>
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(DesignWaterLevelCalculationActivity));
        private readonly IHydraulicBoundaryLocation hydraulicBoundaryLocation;
        private readonly double norm;
        private readonly string hydraulicBoundaryDatabaseFilePath;
        private readonly string ringId;
        private readonly ICalculationMessageProvider messageProvider;

        /// <summary>
        /// Creates a new instance of <see cref="DesignWaterLevelCalculationActivity"/>.
        /// </summary>
        /// <param name="hydraulicBoundaryLocation">The <see cref="IHydraulicBoundaryLocation"/> to perform the calculation for.</param>
        /// <param name="hydraulicBoundaryDatabaseFilePath">The HLCD file that should be used for performing the calculation.</param>
        /// <param name="ringId">The id of the ring to perform the calculation for.</param>
        /// <param name="norm">The norm to use during the calculation.</param>
        /// <param name="messageProvider">The provider of the messages to use during the calculation.</param>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="hydraulicBoundaryLocation"/> is <c>null</c>.</exception>
        public DesignWaterLevelCalculationActivity(IHydraulicBoundaryLocation hydraulicBoundaryLocation, string hydraulicBoundaryDatabaseFilePath, string ringId, double norm, ICalculationMessageProvider messageProvider)
        {
            if (hydraulicBoundaryLocation == null)
            {
                throw new ArgumentNullException("hydraulicBoundaryLocation");
            }

            if (messageProvider == null)
            {
                throw new ArgumentNullException("messageProvider");
            }

            this.hydraulicBoundaryLocation = hydraulicBoundaryLocation;
            this.messageProvider = messageProvider;

            this.hydraulicBoundaryDatabaseFilePath = hydraulicBoundaryDatabaseFilePath;
            this.ringId = ringId;
            this.norm = norm;

            Name = messageProvider.GetActivityName(hydraulicBoundaryLocation.Name);
        }

        protected override void OnRun()
        {
            if (!double.IsNaN(hydraulicBoundaryLocation.DesignWaterLevel))
            {
                State = ActivityState.Skipped;
                return;
            }

            PerformRun(() => DesignWaterLevelCalculationService.Instance.Validate(
                messageProvider.GetCalculationName(hydraulicBoundaryLocation.Name), 
                hydraulicBoundaryDatabaseFilePath),
                       () => RingtoetsCommonDataSynchronizationService.ClearDesignWaterLevel(hydraulicBoundaryLocation),
                       () => DesignWaterLevelCalculationService.Instance.Calculate(hydraulicBoundaryLocation,
                                                                                   hydraulicBoundaryDatabaseFilePath,
                                                                                   ringId,
                                                                                   norm,
                                                                                   messageProvider));
        }

        protected override void OnFinish()
        {
            PerformFinish(() =>
            {
                hydraulicBoundaryLocation.DesignWaterLevel = (RoundedDouble) Output.Result;
                bool designWaterLevelCalculationConvergence = RingtoetsCommonDataSynchronizationService.CalculationConverged(Output, norm);
                if (!designWaterLevelCalculationConvergence)
                {
                    log.Warn(messageProvider.GetCalculatedNotConvergedMessage(hydraulicBoundaryLocation.Name));
                }
                hydraulicBoundaryLocation.DesignWaterLevelCalculationConvergence = designWaterLevelCalculationConvergence
                                                                                       ? CalculationConvergence.CalculatedConverged
                                                                                       : CalculationConvergence.CalculatedNotConverged;
            });
        }
    }
}