FCC/Extension/WayneClassicFdcClient/ForecourtControl/ITankReading.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/ITankReading.cs $
 * 
 * 1     07-03-09 15:37 roger.månsson
 * Created.
 */
#endregion
using System;
using System.Runtime.InteropServices;
namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Data structure carrying the information of a physical tank reading.
    /// </summary>
    [ComVisible(true)]
    public interface ITankReading
    {
        /// <summary>
        /// Id of the Tank where the reading was made.
        /// </summary>
        int TankId { get; }

        /// <summary>
        /// Status of the probe reading.
        /// </summary>
        ProbeState State { get; }

        /// <summary>
        /// Date and time when the phsical reading was made.
        /// </summary>
        DateTime DateTime { get; }

        /// <summary>
        /// Fuel level, read by the probe.
        /// </summary>
        decimal FuelLevel { [return: MarshalAs( UnmanagedType.Currency)]get; }

        /// <summary>
        /// Normalized fuel volume recalculated to the normalized temperature (15° C).
        /// </summary>
        decimal NormalizedFuelLevel { [return: MarshalAs(UnmanagedType.Currency)]get; }

        /// <summary>
        /// Water level, read by the probe.
        /// </summary>
        decimal WaterLevel { [return: MarshalAs(UnmanagedType.Currency)]get; }

        /// <summary>
        /// Fuel temperature, read by the probe.
        /// </summary>
        decimal FuelTemperature { [return: MarshalAs(UnmanagedType.Currency)]get; }

        /// <summary>
        /// Unit of measure for the water level.
        /// </summary>
        UnitOfMeasure WaterLevelUnit { get; }

        /// <summary>
        /// Unit of measure used for the fuel level.
        /// </summary>
        UnitOfMeasure FuelLevelUnit { get; }

        /// <summary>
        /// Indicates if the normalized fuel volume is supplied.
        /// </summary>
        bool NormalizedFuelLevelSupplied { get; }
        
    }
}