#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/ITankEvents.cs $
 * 
 * 2     07-03-09 15:34 roger.månsson
 * Supply success flag in OnReadCompleted event.
 * 
 * 1     07-01-05 15:13 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Event interface for ITank
    /// </summary>
    [ComVisible(true)]
    [InterfaceType( ComInterfaceType.InterfaceIsIDispatch)]
    public interface ITankEvents
    {
        #region Response events

        /// <summary>
        /// Event invoked when the ReadAsync request has completed.
        /// </summary>
        /// <param name="sender">Tank object that raised the event.</param>
        /// <param name="success">Indicates if the reading was performed ok.</param>
        /// <param name="tankReading">The tank reading that was created due to the read request. If success=false, tankreading will be null.</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnReadCompleted(ITank sender, bool success, ITankReading tankReading, object userToken);


        /// <summary>
        /// Event invoked when the RegisterManualTankDippingAsync request has completed.
        /// </summary>
        /// <param name="sender">Tank object that raised the event.</param>
        /// <param name="success">True if the registration succeeded.</param>
        /// <param name="userToken">The user token that was specified in the request.</param>
        void OnRegisterManualTankDippingCompleted(ITank sender, bool success, object userToken);
        
        #endregion 

        #region Unsolicited events

        /// <summary>
        /// Event fired when the connection state of the tank changes
        /// </summary>
        /// <param name="sender">Tank object that raised the event.</param>
        /// <param name="connectionState">The new connection state of the tank.</param>
        void OnConnectionStateChanged(ITank sender, DeviceConnectionState connectionState);

        #endregion 
    }
}