#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/ITankGroup.cs $
 * 
 * 2     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 1     07-01-05 15:13 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// The Tank group interface is used to block and unblock fuellings with nozzles connected to any of 
    /// the tanks in the tank group.
    /// </summary>
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsDual)]
    public interface ITankGroup
    {
        #region Properties

        /// <summary>
        /// Tank group Id
        /// </summary>
        int Id { get;}

        /// <summary>
        /// The collection of physical tanks that is associated with this tank group.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
        ITank[] Tanks { get;}

        /// <summary>
        /// Indicates if all nozzles connected to tanks in this tank group are blocked.
        /// </summary>
        bool Blocked { get;}

        #endregion

        #region Methods

        /// <summary>
        /// Disable fuelling for all pump nozzles linked to this tank group.
        /// </summary>
        /// <param name="userToken"></param>
        void BlockAsync(object userToken);

        /// <summary>
        /// Enable fuelling for all pump nozzles linked to this tank group.
        /// </summary>
        /// <param name="userToken"></param>
        void UnblockAsync(object userToken);

        /// <summary>
        /// Register a manual fuel delivery from the application.
        /// </summary>
        /// <param name="manualDeliveryParameters">The parameters for the manual delivery.</param>
        /// <param name="userToken"></param>
        void RegisterManualDeliveryAsync(IManualFuelDeliveryParameters manualDeliveryParameters, object userToken);

        #endregion
    }
}