#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/Support/ForecourtControl/Wrk/ForecourtControl/Com/IAlarmEventArgs.cs $
 * 
 * 3     07-02-16 9:59 roger.månsson
 * FxCop changes
 * 
 * 2     07-01-05 9:01 roger.månsson
 * Documentation changes
 */
#endregion

using System.Runtime.InteropServices;
namespace Wayne.ForecourtControl.Com
{
    /// <summary>
    /// Contains information about an alarm.
    /// </summary>
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsDual)]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1711:IdentifiersShouldNotHaveIncorrectSuffix")]
    public interface IAlarmEventArgs
    {
        /// <summary>
        /// Device id for the device that the alarm was about.
        /// </summary>
        int DeviceId { get; }
        
        /// <summary>
        /// Type of device.
        /// </summary>
        int DeviceType { get; set; }

        /// <summary>
        /// Alarm code.
        /// </summary>
        int AlarmCode { get; set; }

        /// <summary>
        /// Category of the alarm
        /// </summary>
        int AlarmCategory { get; set; }

        /// <summary>
        /// Debug text for the alarm.
        /// </summary>
        string DebugText { get; set; }
    }    
}