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

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/IFuelDeliveryEventArgs.cs $
 * 
 * 3     07-03-09 15:33 roger.månsson
 * Use MarshalAs (Currency) on decimal properties that should be exposed
 * COM.
 * 
 * 2     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 1     07-01-05 15:13 roger.månsson
 * Created
 */
#endregion
using System;
using System.Runtime.InteropServices;

namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Interface to Data structure that contains data for a manual fuel delivery registration.
    /// </summary>
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsDual)]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1711:IdentifiersShouldNotHaveIncorrectSuffix")]
    public interface IFuelDeliveryEventArgs
    {
        /// <summary>
        /// Defines how the delivery was registered. I.e detected from a tank probe or 
        /// a manual registration.
        /// </summary>
        FuelDeliveryType Type { get;}

        /// <summary>
        /// Id of the tank group that the delivery was made to.
        /// </summary>
        int TankGroupId { get; }

        /// <summary>
        /// Start date and time for the delivery.
        /// </summary>
        DateTime StartDateTime { get;}

        /// <summary>
        /// End date and time for the delivery.
        /// </summary>
        DateTime EndDateTime { get;}

        /// <summary>
        /// The delivered volume.
        /// </summary>
        decimal Quantity { [return: MarshalAs(UnmanagedType.Currency)]get;}

        /// <summary>
        /// Optional. The volume that was planned to deliver.
        /// </summary>
        decimal PlannedQuantity { [return: MarshalAs(UnmanagedType.Currency)]get;}

        /// <summary>
        /// Optional. Temperature of the fuel in the truck.
        /// </summary>
        decimal TruckFuelTemperature { [return: MarshalAs(UnmanagedType.Currency)]get;}

        /// <summary>
        /// Optional. Plant where the truck came from. Free format string.
        /// </summary>
        string SourcePlantInfo { get;}

        /// <summary>
        /// Optional. Note reference number entered by the truck driver.
        /// </summary>
        string ReferenceNote { get;}
    }
}