FCC/Extension/WayneClassicFdcClient/ForecourtControl/Com/ITank.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/ITank.cs $
 * 
 * 2     07-03-09 15:34 roger.månsson
 * Use MarshalAs (Currency) on decimal parameters that should be exposed
 * COM
 * 
 * 1     07-01-05 15:13 roger.månsson
 * Created
 */
#endregion

using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Interface to the representation of a physical fuel tank. The tanks are grouped in Tank groups,
    /// where several tanks are linked together.
    /// </summary>    
    [ComVisible(true)]
    [InterfaceType( ComInterfaceType.InterfaceIsDual)]
    public interface ITank
    {
        #region Properties

        /// <summary>
        /// Id of the tank. 
        /// </summary>
        int Id { get;}

        /// <summary>
        /// The tank group this tank is associated with.
        /// </summary>
        ITankGroup TankGroup { get;}

        /// <summary>
        /// Indicates the connection state of the tank probe.
        /// </summary>
        DeviceConnectionState ConnectionState { get;}

        /// <summary>
        /// The latest physical reading from the TIG
        /// </summary>
        ITankReading LatestPhysicalReading { get;}

        /// <summary>
        /// Indicates if this tank has a probe for physical tank reading.
        /// </summary>
        bool CapPhysicalReading { get;}

        #endregion
        
        #region Methods

        /// <summary>
        /// Starts a physical tank reading if a physical probe is available.
        /// </summary>
        /// <param name="userToken"></param>
        void ReadAsync(object userToken);

        /// <summary>
        /// Used to register manual tank dipping from the application.
        /// </summary>
        /// <param name="tankLevel"></param>
        /// <param name="userToken"></param>
        void RegisterManualTankDippingAsync([param:MarshalAs(UnmanagedType.Currency)] decimal tankLevel, object userToken);

        #endregion

    }
}