FCC/Extension/WayneClassicFdcClient/ForecourtControl/EventArgs/FuellingStateChangeEventArgs.cs

using System;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Event argument for a  FuellingState change event in a Pump object.
    /// </summary>
    public class FuellingStateChangeEventArgs : EventArgs
    {
        #region Fields
        private IFuelling fuelling;
        private FuellingState state;
        #endregion

        #region Constructor
        /// <summary>
        /// Constructor
        /// </summary>
        ///<param name="fuelling"></param>
        ///<param name="state"></param>
        public FuellingStateChangeEventArgs(IFuelling fuelling, FuellingState state)
        {
            this.fuelling = fuelling;
            this.state = state;
        }
        #endregion

        #region Properties
        /// <summary>
        /// Fuelling which change has changed. If this parameter is NULL, then a fuelling have been removed from the pump.
        /// </summary>
        public IFuelling Fuelling { get { return fuelling; } }

        /// <summary>
        /// New Fuelling state
        /// </summary>
        public FuellingState State { get { return state; } }
        #endregion

        #region Debug methods

        /// <summary>
        /// Presents the class as a string.
        /// </summary>
        /// <returns></returns>
        public virtual string ToString(string format, IFormatProvider provider)
        {
            return String.Format(System.Globalization.CultureInfo.InvariantCulture, "FuellingStateChange, FuellingSq={0}, State={1}", (fuelling != null) ? fuelling.FuellingSequenceNumber.ToString(provider) : "null", state.ToString());
        }

        /// <summary>
        /// Presents the class as a string using the specified culture-specific format information.
        /// </summary>
        /// <returns></returns>
        public virtual string ToString(IFormatProvider provider)
        {
            return ToString("", provider);
        }

        /// <summary>
        /// Presents the class as a string using a format string.
        /// </summary>
        /// <returns></returns>
        public virtual string ToString(string format)
        {
            return ToString(format, System.Globalization.CultureInfo.InvariantCulture);
        }

        /// <summary>
        /// Presents the class as a string using a format string and the specified culture-specific format information.
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return ToString("", System.Globalization.CultureInfo.InvariantCulture);
        }

#endregion
    }
}