using System;
using System.ServiceModel;

namespace Deltares.RtcTools.Net
{
	///<summary>
	/// Specification of the methods that are and must be available in the native DLL of RtcTools
	///</summary>
    [ServiceContract]
    public interface IRtcToolsDll
	{
	    /// <summary>
	    /// Initialize the RtcTools computational core
	    /// </summary>
	    /// <param name="directoryPathForXmlFiles">The directory path where the RtcTools files can be found</param>
	    /// <param name="schemaLocation">The relative path where the xsd can be found</param>
        [OperationContract]
        void Initialize(string directoryPathForXmlFiles, string schemaLocation);

		/// <summary>
		/// Get the start date and time of the RtcTools computation as a string
		/// </summary>
        /// <returns>Return the start date and time as a string, formatted as "YY-MM-DD hh:mm:ss"</returns>
        [OperationContract]
        string GetStartTimeString();

		/// <summary>
		/// Get the start time of the RtcTools computation as Modified Julian Day
		/// </summary>
		/// <returns>The start time of the RtcTools computation as Modified Julian Day</returns>
        [OperationContract]
        double GetStartTimeAsMJD();

		/// <summary>
		/// Get the end date and time of the RtcTools computation as a string
		/// </summary>
        /// <returns>Return the start date and time as a string, formatted as "YY-MM-DD hh:mm:ss"</returns>
        [OperationContract]
        string GetEndTimeString();

		/// <summary>
		/// Get the end time of the RtcTools computation as Modified Julian Day
		/// </summary>
		/// <returns>The end time of the RtcTools computation as Modified Julian Day</returns>
        [OperationContract]
        double GetEndTimeAsMJD();

		/// <summary>
		/// Get the number of input exchange items.
		/// </summary>
		/// <returns>The number of input exchange items</returns>
        [OperationContract]
        int GetInputExchangeItemCount();

		/// <summary>
		/// Get the quantity identification string for the input exchange item with index "index".
		/// </summary>
		/// <returns>The quantity identifier </returns>
        [OperationContract]
        string InputExchangeItemGetQuantityId(int index);

		/// <summary>
		/// Get the element set identification string for the input exchange item with index "index".
		/// </summary>
		/// <returns>The element set identifier </returns>
        [OperationContract]
        string InputExchangeItemGetElementId(int index);

		/// <summary>
		/// Get the unit identification string for the input exchange item with index "index".
		/// </summary>
        [OperationContract]
        string InputExchangeItemGetUnit(int index);

		/// <summary>
		/// Get the number of input exchange items.
		/// </summary>
		/// <returns>The number of input exchange items</returns>
        [OperationContract]
        int GetOutputExchangeItemCount();

		/// <summary>
		/// Get the quantity identification string for the output exchange item with index "index".
		/// </summary>
		/// <returns>The quantity identifier</returns>
        [OperationContract]
        string OutputExchangeItemGetQuantityId(int index);

		/// <summary>
		/// Get the element set identification string for the output exchange item with index "index".
		/// </summary>
        [OperationContract]
        string OutputExchangeItemGetElementId(int index);

		/// <summary>
		/// Get the unit identification string for the output exchange item with index "index".
		/// </summary>
        [OperationContract]
        string OutputExchangeItemGetUnit(int index);

		/// <summary>
		/// Set the input value for an input exchange item
		/// </summary>
		/// <param name="index">The index of the input exchange item</param>
		/// <param name="value">The value to be set</param>
        [OperationContract(Name = "SetValue_1")]
        void SetValue(int index, double value);
        [OperationContract(Name = "SetValue_2")]
        void SetValue(int index, double value, int timeStepCount);
        // TODO: merge functions to one with optional parameter when moving to C# (vs2010 or higher)

		/// <summary>
		/// Let the RtcTools computational core perform a time step
		/// </summary>
        [OperationContract(Name = "PerformTimeStep_1")]
        void PerformTimeStep();
        [OperationContract(Name = "PerformTimeStep_2")]
        void PerformTimeStep(int timeStepCount);
        // TODO: merge functions to one with optional parameter when moving to C# (vs2010 or higher)

		/// <summary>
        /// Get the current date and time of the RtcTools computation as a string
        /// </summary>
        /// <returns>Return the current date and time as a string, formatted as "YY-MM-DD hh:mm:ss"</returns>
        [OperationContract]
        string GetCurrentTimeString();

		/// <summary>
		/// Get the current time of the RtcTools computation as Modified Julian Day
		/// </summary>
		/// <returns>The current time of the RtcTools computation as Modified Julian Day</returns>
        [OperationContract]
        double GetCurrentTimeAsMJD();

		/// <summary>
		/// Get the value of an output exchange item
		/// </summary>
		/// <param name="index">The index of the output exchange item</param>
		/// <returns>The current value of the output exchange item</returns>
        [OperationContract]
        double GetValue(int index);

        /// <summary>
        /// Write statefile
        /// </summary>
        /// <param name="path">path to write the statefile to</param>
        /// <param name="filename">filename to use for the statefile</param>
	    [OperationContract]
	    void WriteState(string path, string filename);

		/// <summary>
		/// Let the RtcTools computational core perform its finalization actions
		/// </summary>
        [OperationContract]
        void Finish();

		/// <summary>
		/// Release the memory allocated by the RtcTools computational core
		/// </summary>
        [OperationContract]
        void Dispose();
	}
}