using System.Collections.Generic;
using Deltares.DamEngine.Calculators.KernelWrappers.Common;
using Deltares.DamEngine.Data.General.Results;
using Deltares.DamEngine.Data.Standard.Logging;

namespace Deltares.DamEngine.Calculators.KernelWrappers.Interfaces
{
    /// <summary>
    /// Result of the Prepare method
    ///   Successful : the input data was created susccesfully
    ///   Failed     : the input data could not be created
    ///   NotRelevant: the DamKernelInput contains data that is not a relevant input for this mechanism 
    /// </summary>
    public enum PrepareResult
    {
        Successful,  
        Failed,
        NotRelevant
    };
    /// <summary>
    /// Interface to implement external failure mechanisms
    /// </summary>
    interface IKernelWrapper
    {
        /// <summary>
        /// Prepares the failure mechanism input based on general dam kernel input.
        /// </summary>
        /// <param name="damKernelInput">The dam kernel input.</param>
        /// <param name="kernelDataInput">The kernel data input.</param>
        /// <param name="kernelDataOutput">The kernel data output.</param>
        /// <returns>
        /// Result of the prepare
        /// </returns>
        PrepareResult Prepare(DamKernelInput damKernelInput, out IKernelDataInput kernelDataInput, out IKernelDataOutput kernelDataOutput);
        /// <summary>
        /// Validates the kernel data input.
        /// </summary>
        /// <param name="kernelDataInput">The kernel data input.</param>
        /// <param name="kernelDataOutput">The kernel data output.</param>
        /// <param name="messages">The messages.</param>
        /// <returns>
        /// Number of errors that prevent a calculation
        /// </returns>
        int Validate(IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, out List<LogMessage> messages);
        /// <summary>
        /// Performs a failure mechanism calculation based on the input.
        /// </summary>
        /// <param name="kernelDataInput">The kernel data input.</param>
        /// <param name="kernelDataOutput">The kernel data output.</param>
        /// <param name="messages">The messages.</param>
        void Execute(IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, out List<LogMessage> messages);
        /// <summary>
        /// Fills the dam result based on the kernel output.
        /// </summary>
        /// <param name="damKernelInput">The dam kernel input.</param>
        /// <param name="kernelDataOutput">The kernel data output.</param>
        /// <param name="resultMessage">The result message.</param>
        /// <param name="designResult">The design result.</param>
        void PostProcess(DamKernelInput damKernelInput, IKernelDataOutput kernelDataOutput, string resultMessage, out DesignResult designResult);
    }
}