///
/// Copyright (c) 2013-2017 Sensus Metering Systems
///
using System.Collections.Generic;
using TBF.BenchControl.Generic;
using TBF.Boxes;

namespace TBF.BenchControl.GenericDevices
{
	/// <summary>
	/// Basic balance functions
	/// </summary>
	public interface IScale : IComponent
	{
        /// <summary>
        /// Balance number: 0-based index required for communication with the Elde component
        /// </summary>
        int ScaleNr { get; }

        /// <summary>
        /// Balance water tank capacity in kg or ltr
        /// </summary>
		double Capacity { get; }

		/// <summary>
		/// Water tank drain valve or 'null'
		/// </summary>
		IValve DrainValve { get; }

        /// <summary>
        /// Returns true if tank s empty, mass is less then some threshold
        /// </summary>
        bool IsEmpty(double mass);

		/// <summary>
		/// Returns true if tank s empty, the last measured mass is less then some threshold
		/// </summary>
		bool IsEmpty();

		/// <summary>
		/// Format string to be used as ToString() argument (e.g. "F3" to obtain resolution 1g)
		/// </summary>
		string Format { get; }

        /// <summary>
        /// Time in seconds to empty the tank completely when it is full
        /// </summary>
        int EmptyTimeSec { get; }

        float BuoyancyTemp { get; }         ///
        float BuoyancyPress { get; }        /// Displayed in Metrology tab page
        float BuoyancyHumi { get; }         ///

        /// <summary>
		/// Measurement correction table
		/// </summary>
		IList<Config.Entities.MeasurementCorrection> Corrections { get; }

		/// <summary>
		/// Events:  BalanceDone, Error
		/// </summary>
		/// <param name="result">Reference to a variable for 'tara' in kg</param>
		/// <returns>TaringOp instance reference casted to IOperaton</returns>
		IOperation TaringOp(ref DoubleBox tara);

		/// <summary>
		/// Events:  BalanceDone, Error
		/// </summary>
		/// <param name="result">Reference to a variable for the measured mass in kg</param>
		/// <returns>ReadMassOp instance reference casted to IOperaton</returns>
        IOperation ReadMassOp(ref DoubleBox mass);

		/// <summary>
		/// Events:  BalanceDone, Error
		/// </summary>
		/// <param name="result">Reference to a variable for the measured mass in kg</param>
		/// <param name="readingsCount">Required mass readings count (>= 3)</param>
        /// <param name="maxSpread">Maximum spread of measurements in kg (otherwise the measurement continues)</param>
        /// <param name="method">Method: false = slow (precise), true = fast (immediate)</param>
		/// <returns>ReadMassAverageOp instance reference casted to IOperaton</returns>
		IOperation ReadStableMassOp(ref DoubleBox mass, int readingsCount, double maxSpread, Config.Entities.MassMethod method);

        /// <summary>
        /// Events:  Done, Error
        /// </summary>
        /// <param name="serialNumber">Reference to the serialNumber</param>
        /// <returns>GetBalanceSerNumOp instance reference casted to IOperaton</returns>
        IOperation GetSerNumOp(ref string serialNumber);
    }
}