FCC/Extension/GlobalPumpFdc/Support/ForecourtControlG/TankReading.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/TankReading.cs $
 * 
 * 3     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 2     07-01-09 9:28 roger.månsson
 * Documentation fixes
 * 
 * 1     07-01-05 15:12 roger.månsson
 * Created
 */
#endregion
using System;
using System.Collections.Generic;
using System.Text;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Data structure carrying the information of a physical tank reading.
    /// </summary>
    public class TankReading // : Com.ITankReading
    {
        #region Fields

        ITank tank;
        ProbeState state;
        DateTime dateTime;
        decimal fuelLevel;
        decimal normalizedFuelLevel;
        decimal waterLevel;
        decimal fuelTemperature;
        UnitOfMeasure fuelLevelUnit;
        UnitOfMeasure waterLevelUnit;
        bool normalizedFuelLevelSupplied;

        #endregion

        #region Construction
        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="tank"></param>
        /// <param name="state"></param>
        /// <param name="dateTime"></param>
        /// <param name="fuelLevel"></param>
        /// <param name="normalizedFuelLevel"></param>
        /// <param name="waterLevel"></param>
        /// <param name="fuelTemperature"></param>
        /// <param name="fuelLevelUnit"></param>
        /// <param name="waterLevelUnit"></param>
        /// <param name="normalizedFuelLevelSupplied"></param>
        public TankReading(ITank tank, ProbeState state, DateTime dateTime, decimal fuelLevel, decimal normalizedFuelLevel,
                           decimal waterLevel, decimal fuelTemperature, UnitOfMeasure fuelLevelUnit, UnitOfMeasure waterLevelUnit, 
                           bool normalizedFuelLevelSupplied)
        {
            this.tank = tank;
            this.state = state;
            this.dateTime = dateTime;
            this.fuelLevel = fuelLevel;
            this.normalizedFuelLevel = normalizedFuelLevel;
            this.waterLevel = waterLevel;
            this.fuelTemperature = fuelTemperature;
            this.fuelLevelUnit = fuelLevelUnit;
            this.waterLevelUnit = waterLevelUnit;
            this.normalizedFuelLevelSupplied = normalizedFuelLevelSupplied;
        }
        #endregion

        #region ITankReading Members

        /// <summary>
        /// Tank where the reading was made.
        /// </summary>
        public ITank Tank
        {
            get { return tank ; }
        }

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

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

        /// <summary>
        /// Fuel level, read by the probe.
        /// </summary>
        public decimal FuelLevel
        {
            get { return fuelLevel; }
        }

        /// <summary>
        /// Normalized fuel volume recalculated to the normalized temperature (15° C).
        /// </summary>
        public decimal NormalizedFuelLevel
        {
            get { return normalizedFuelLevel; }
        }

        /// <summary>
        /// Water level, read by the probe.
        /// </summary>
        public decimal WaterLevel
        {
            get { return waterLevel; }
        }

        /// <summary>
        /// Fuel temperature, read by the probe.
        /// </summary>
        public decimal FuelTemperature
        {
            get { return fuelTemperature; }
        }

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

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

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

        #endregion
    }
}