using System;

namespace DTS.Common.Interface.Sensors.SensorsList
{
    public interface IDigitalOutputSetting
    {
        /// <summary>
        /// database id for digital output setting
        /// only ids > 0 are valid
        /// </summary>
        int DatabaseId { get; set; }
        /// <summary>
        /// whether digital output should have a check in a list with a checkbox
        /// </summary>
        bool Included { get; set; }
        /// <summary>
        /// serialnumber/setting name for digital output setting
        /// </summary>
        string SerialNumber { get; set; }
        /// <summary>
        /// description/comment for setting
        /// </summary>
        string Description { get; set; }
        /// <summary>
        /// delay in ms before outputting
        /// </summary>
        double DODelay { get; set; }
        /// <summary>
        /// duration in ms of output (if limiting duration)
        /// </summary>
        double DODuration { get; set; }
        /// <summary>
        /// who last modified the digital output
        /// </summary>
        string ModifiedBy { get; set; }
        /// <summary>
        /// when the digital output was last modified
        /// </summary>
        DateTime LastModified { get; set; }
        /// <summary>
        /// returns true if the digital output matches filter criteria
        /// </summary>
        /// <param name="term"></param>
        /// <returns></returns>
        bool Filter(string term);
        /// <summary>
        /// whether digital output is associated with a channel
        /// </summary>
        bool Assigned { get; set; }
        /// <summary>
        /// whether digital output was found online or not (there's no real way of finding digital output online, it has no EID)
        /// </summary>
        bool Online { get; set; }
        /// <summary>
        /// isocode associated with digital output
        /// digital outputs aren't in collected data so there's not a real need for this ...
        /// </summary>
        string ISOCode { get; set; }
        /// <summary>
        /// iso channel name associated with digital output
        /// digital outputs aren't in collected data so there's no real need for this ...
        /// </summary>
        string ISOChannelName { get; set; }
        /// <summary>
        /// user code associated with digital output
        /// there's no collected data for outputs so there's no real need for this
        /// </summary>
        string UserCode { get; set; }
        /// <summary>
        /// user channel name associated with digital output
        /// there's no collected data for outputs so there's no real need for this
        /// </summary>
        string UserChannelName{ get; set; }
        /// <summary>
        /// whether output should be limited or not
        /// </summary>
        bool LimitDuration { get; set; }
        /// <summary>
        /// the output mode for the digital output setting
        /// </summary>
        Enums.DigitalOutputModes DOMode { get; set; }
        /// <summary>
        /// used to mark whether the digital output is broken
        /// broken sensors do not appear in selectable lists of sensors in edit group or edit test setup
        /// </summary>
        bool Broken{ get; set; }
        /// <summary>
        /// used to mark whether the digital output should not be used
        /// donotuse sensors do not appear in selectable lists of sensors in edit group or edit test setup
        /// </summary>
        bool DoNotUse{ get; set; }
    }
}