using DTS.Common.Enums;
using System;

namespace DTS.Common.Interface.Sensors.SensorsList
{
    /// <summary>
    /// interface describes objects used in the UI to display digital inputs
    /// </summary>
    public interface IDigitalInputSetting
    {
        /// <summary>
        /// ID in the database for the digital input setting
        /// only positive numbers are valid database ids
        /// </summary>
        int DatabaseId { get; set; }
        /// <summary>
        /// whether the digital input is checked in a list with a checkbox
        /// </summary>
        bool Included { get; set; }
        /// <summary>
        /// the serial number / setting name 
        /// </summary>
        string SerialNumber { get; set; }
        /// <summary>
        /// description or comment of setting
        /// </summary>
        string Description { get; set; }
        /// <summary>
        /// string representation of the Digital Input Mode of the setting
        /// </summary>
        string DIMode { get; set; }
        /// <summary>
        /// the user who last modified setting
        /// </summary>
        string ModifiedBy { get; set; }
        /// <summary>
        /// when the setting was last modified
        /// </summary>
        DateTime LastModified { get; set; }
        /// <summary>
        /// returns true if digital input matches filter criteria
        /// </summary>
        /// <param name="term"></param>
        /// <returns></returns>
        bool Filter(string term);
        /// <summary>
        /// whether the digital input is associated with a channel
        /// </summary>
        bool Assigned { get; set; }
        /// <summary>
        /// whether the digital input is online or not
        /// </summary>
        bool Online { get; set; }
        /// <summary>
        /// electronic id associated with the digital input
        /// </summary>
        string EID { get; set; }
        /// <summary>
        /// the isocode for the digital input
        /// </summary>
        string ISOCode { get; set; }
        /// <summary>
        /// the iso channel name for the digital input
        /// </summary>
        string ISOChannelName { get; set; }
        /// <summary>
        /// the user code for the digital input
        /// </summary>
        string UserCode { get; set; }
        /// <summary>
        /// the user channel name for the digital input
        /// </summary>
        string UserChannelName { get; set; }
        /// <summary>
        /// the active value of digital input as a string
        /// this is the what to display when the digital input is in active state
        /// </summary>
        string ActiveValue { get; set; }
        /// <summary>
        /// the string representation of the state of the digital input in it's default state
        /// this is what to display when the digital input is in idle, inactive, or the default state
        /// </summary>
        string DefaultValue { get; set; }
        DigitalInputModes Mode { get; set; }
        /// <summary>
        /// marks the digital input setting as broken or not
        /// broken sensors do not appear in selectable lists of sensors in edit test setup or edit group
        /// </summary>
        bool Broken { get; set; }
        /// <summary>
        /// marks the digital input setting as donotuse
        /// donotuse sensors do not appear in selectable lists of sensors in edit test setup or edit group
        /// </summary>
        bool DoNotUse { get; set; }
    }
}