#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/EventArgs/PumpEventOccuredEventArgs.cs $
 * 
 * 5     07-03-14 7:50 roger.månsson
 * Documentation.
 * 
 * 4     07-03-01 17:48 roger.mnsson
 * Added ToString()
 * 
 * 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-08 16:10 roger.månsson
 * Created
 */
#endregion
using System;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Event argument for a PumpEvent, specifying that a certain event has occured on a pump.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Occured")]
    public class PumpEventOccuredEventArgs : EventArgs
    {
        #region Fields

        private PumpEventType eventType;

        #endregion

        #region Construction

        /// <summary>
        /// Initializes a new instance of the PunpEventOccuredEventArgs class.
        /// </summary>
        /// <param name="eventType">The event type that occured.</param>
        public PumpEventOccuredEventArgs(PumpEventType eventType)
        {
            this.eventType = eventType;
        }

        #endregion

        #region Properties

        /// <summary>
        /// The type of the Event 
        /// </summary>
        public PumpEventType EventType
        {
            get { return eventType; }
        }

        #endregion

        #region Methods

        /// <summary>
        /// Returns a string representation of the object.
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return string.Format(System.Globalization.CultureInfo.InvariantCulture, "PumpEventOccuredEventArgs, event={0}", eventType);
        }

        #endregion
    }
}