FCC/Extension/GlobalPumpFdc/Support/ForecourtControlG/EventArgs/PumpReservationStateChangeEventArgs.cs

using System;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Event argument for a PumpReservationStateChange Event.
    /// </summary>
    public class PumpReservationStateChangeEventArgs : EventArgs
    {
        #region Fields
        private IPump pump;
        private int reservedBy;
        #endregion

        #region Constructor
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="pump"></param>
        /// <param name="reservedBy">Who is reserving this pump (0 if none)</param>
        public PumpReservationStateChangeEventArgs(IPump pump, int reservedBy)
        {
            this.pump = pump;
            this.reservedBy = reservedBy;
        }
        #endregion

        #region Properties
        /// <summary>
        /// The new reserving client id.
        /// </summary>
        public int ReservedBy { get { return reservedBy; } }

        /// <summary>
        /// The Pump whose reservation state was changed.
        /// </summary>
        public IPump Pump
        {
            get { return pump; }
            set { pump = value; }
        }
        #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,"PumpReservationStateChange PumpId={0}, ReservedBy={1}", pump.Id, reservedBy.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
    }
}