#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/INozzle.cs $
 * 
 * 3     07-07-31 14:36 roger.månsson
 * Made Com visible.
 * 
 * 2     07-01-05 15:14 roger.månsson
 * Added ReadPumpAccumulatorAsync method
 * 
 * 1     07-01-05 9:00 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Represents a nozzle 
    /// </summary>
    [ComVisible(true)]
    public interface INozzle 
    {
        #region Properties

        /// <summary>
        /// Nozzle Id. 
        /// </summary>
        int Id { get;}

        /// <summary>
        /// State of the Nozzle.
        /// </summary>
        NozzleState State { get;}

        /// <summary>
        /// The primary tank group.
        /// </summary>
        int PrimaryTankGroupId { get;}

        /// <summary>
        /// Blend percentage drawn from the Primary TankGroup. The rest will be drawn from the secondary TankGroup. (100 % for non blending pumps.)
        /// </summary>
        int PrimaryTankGroupPercentage { get;}

        /// <summary>
        /// Pointer to the secondary tank group. Blend percentage is 100 % - PrimaryTankPercentage.
        /// </summary>
        int SecondaryTankGroupId { get;}

        /// <summary>
        /// Indicates the fuel grade that is connected to this nozzle.
        /// </summary>
        int FuelGrade { get;}
        #endregion

        #region Methods

        /// <summary>
        /// Requests a momentary reading of the physical accumulators for the nozzle.
        /// </summary>
        /// <param name="userToken"></param>
        void ReadPumpAccumulatorAsync(object userToken);

        #endregion
    }
}