using System;

namespace DeltaShell.Plugins.XBeach.Api
{
    public interface IXBeachApi : IDisposable
    {
         
        void Initialize(string workingDirectory);

        CurvilinearGrid Grid {  get;  set; }

        double[] Get1DDoubleOutputArray(string name);

        double[] GetDoubleOutputArray(string name);
        
        void SetDoubleOutputArray(double[] array, string name);

        /// <summary>
        /// TODO: refactor it to be a method, since it always returns a new object, or always return the same instance
        /// </summary>
        double[] Bathymetry {  get;  set;}

        DateTime StartTime {  get; }

        DateTime CurrentTime {  get; }

        DateTime StopTime {  get; }

        TimeSpan OutputTimeStep {  get; }
        
        void ExecuteStep();

        
        void WriteOutput();

        /// <summary>
        /// Dynamic access to the XBeach model paramater names.
        /// </summary>
        /// <returns></returns>
        
        string[] GetParameterNames();

        /// <summary>
        /// Dynamic access to the XBeach model paramater types.
        /// </summary>
        /// <returns></returns>
        
        Type GetParameterType(string name);

        /// <summary>
        /// Dynamic access to the XBeach model paramater values.
        /// </summary>
        /// <returns></returns>
        double GetDoubleParameter(string name);

        /// <summary>
        /// Dynamic access to the XBeach model paramater values.
        /// </summary>
        /// <returns></returns>
        int GetIntParameter(string name);
    }
}