FCC/Extension/GlobalPumpFdc/Support/ForecourtControlG/INozzle.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/INozzle.cs $
 * 
 * 4     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 3     07-01-05 15:12 roger.månsson
 * Added ReadPumpAccumulatorAsync method
 * 
 * 2     07-01-05 8:59 roger.månsson
 * Renamed NozzleState->State
 */
#endregion
using System;
using Wayne.Lib;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Represents a nozzle 
    /// </summary>
    public interface  INozzle : Wayne.Lib.IIdentifiableEntity
    {
        #region Properties
        /// <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;}

        /// <summary>
        /// The tank nozzle is connected to.
        /// </summary>
        int PrimaryTankNo { get; }

        /// <summary>
        /// The tank nozzle is connected to.
        /// </summary>
        int SecondaryTankNo { get; }
        
        #endregion

        #region Methods

        /// <summary>
        /// Requests a momentary reading of the physical accumulators for the nozzle.
        /// </summary>
        /// <param name="accumulatorsRead"></param>
        /// <param name="userToken"></param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures")]
        void ReadPumpAccumulatorAsync(EventHandler<AsyncCompletedEventArgs<PumpAccumulatorReading>> accumulatorsRead, object userToken);

        #endregion
    }
}