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

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/EventArgs/SiteModeChangeEventArgs.cs $
 * 
 * 4     07-03-14 7:50 roger.månsson
 * Documentation.
 * 
 * 3     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 2     07-01-31 14:00 roger.månsson
 * Added ToString() methods
 */
#endregion
using System;

namespace Wayne.ForecourtControl
{
    /// <summary>
    /// Event argument in the OnSiteModeChange event in ForecourtControl.
    /// </summary>
    public sealed class SiteModeChangeEventArgs : EventArgs
    {
        #region Fields
        int siteMode;
        bool siteOpen;
        #endregion

        #region Construction
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="siteMode"></param>
        /// <param name="siteOpen"></param>
        public SiteModeChangeEventArgs(int siteMode, bool siteOpen)
        {
            this.siteMode = siteMode;
            this.siteOpen = siteOpen;
        }
        #endregion

        #region Properties
        /// <summary>
        /// Sets the site mode of the station.
        /// </summary>
        public int SiteMode { get { return siteMode; } }
        /// <summary>
        /// Opens or closes the site.
        /// </summary>
        public bool SiteOpen { get { return siteOpen; } }
        #endregion

        #region ToString
        /// <summary>
        /// Returns a string representation of the object.
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return string.Format(System.Globalization.CultureInfo.InvariantCulture, "SiteModeChangeEventArgs {{SiteMode={0},SiteOpen={1}}}", siteMode, siteOpen);
        }
        #endregion
    }
}