FCC/Extension/WayneClassicFdcClient/ForecourtControl/ITankGroup.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/ITankGroup.cs $
 * 
 * 2     07-03-09 15:37 roger.månsson
 * Added Fuel grade in interface. Use IManualFuelDeliveryParameters
 * instead of ManualFuelDeliveryParameters class in the interface.
 * 
 * 1     07-01-05 15:12 roger.månsson
 * Created
 */
#endregion
using System;
using Wayne.Lib;

namespace Wayne.ForecourtControl
{
    /// <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>    
    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.Collections.ObjectModel.ReadOnlyCollection<ITank> Tanks { get;}

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

        /// <summary>
        /// The fuel product the tank group contains.
        /// </summary>
        int FuelGrade { get;}

        #endregion 

        #region Events
        /// <summary>
        /// Event that is fired when a fuel delivery is detected. It can be both manual and probe detected deliveries.
        /// </summary>
        event EventHandler<FuelDeliveryEventArgs> OnFuelDelivery;
        #endregion

        #region Methods

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

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

        /// <summary>
        /// Register a manual fuel delivery from the application.
        /// </summary>
        /// <param name="manualDeliveryParameters"></param>
        /// <param name="deliveryRegistrationCompleted"></param>
        /// <param name="userToken"></param>
        void RegisterManualDeliveryAsync(IManualFuelDeliveryParameters manualDeliveryParameters, EventHandler<AsyncCompletedEventArgs> deliveryRegistrationCompleted, object userToken);
                                         
        #endregion 
            
    }
}