///
/// Copyright (c) 2013-2022 Sensus Slovensko a.s.
///
using System.Collections.Generic;
using TBF.Rig.Generic;
using TBF.Boxes;

namespace TBF.Rig.GenericDevices
{
	/// <summary>
	/// Basic flow meter functions
	/// </summary>
	public interface IFlowMeter : IComponent
	{
        /// <summary>
        /// Reference flow meter communicated to the board: 1-based index, 0 for parallel flow meters
        /// </summary>
        int Idx1 { get; }

        /// <summary>
        /// Nominal (uncorrected) volume per flowmeter pulse in [l].
        /// </summary>
        double LtrPerPulse { get; }

        /// <summary>
        /// Corrected volume per flowmeter pulse in [l].
        /// </summary>
        /// <param name="flow">Water flow in [m3/h]</param>
        /// <param name="temperature">Water temperature in [°C]</param>
        double LtrPerPulseCorrected(double flow, float temperature);

        /// <summary>
        /// Nominal flow in m3/h at the nominal output frequency (see below).
        /// In case of a flowmeter couple, the sum of two nominal flows (reached at sum of nominal freq.).
        /// </summary>
        double NominalFlow { get; }

        /// <summary>
        /// Nominal frequency in Hz.
        /// </summary>
        double NominalFreq { get; }

        /// <summary>
        /// Returns current flow value in [m3/h]
        /// </summary>
        /// <returns>Flow in m3/h</returns>
        double ReadFlow();

        /// <summary>
        /// Returns current flow meter frequency value in [Hz]
        /// </summary>
        /// <returns>Frequency in Hz</returns>
        double ReadFrequency();

        /// <summary>
		/// Events:  FlowDone, Error
		/// </summary>
		/// <param name="flow">Reference to a variable for the measured flow in xxx</param>
		/// <returns>ReadFlowOp instance reference casted to IOperaton</returns>
		IOperation ReadFlowOp(ref DoubleBox flow);

		/// <summary>
		/// Events:  flowDone, Error
		/// </summary>
		/// <param name="flow">Reference to a variable for the measured flow in xxx</param>
		/// <param name="flowDone">Event returned when measurement done</param>
		/// <returns>ReadFlowOp instance reference casted to IOperaton</returns>
		IOperation ReadFlowOp(ref DoubleBox flow, Event flowDone);

        bool MsrmntAvailable { get; }
        double MeasuredVal { get; }
        double MsrdValLimLo { get; }
        double MsrdValLimHi { get; }
        string MsrdFormat { get; }
        Common.Unit MsrdUnit { get; }
        string AltString { get; }
    }
}