using System.Xml;
using System.Xml.Schema;

namespace DTS.Common.Interface.DASFactory.Config
{
    public interface IConfigurationData
    {
        /// <summary>
        /// Array of Module objects in the DAS.
        /// </summary>
        IDASModule[] Modules { get; set; }

        /// <summary>
        /// EID's for the whole DAS.
        /// </summary>
        IEID[] IDs { get; set; }

        /// <summary>
        /// The ID of the current test/event.
        /// </summary>
        string TestID { get; set; }
        string TestSetupUniqueId { get; set; }

        /// <summary>
        /// The ID of an instance of a test run, for the purpose
        /// of identifying where to download data.
        /// </summary>
        string InstanceID { get; set; }

        /// <summary>
        /// A description of the current test/event.
        /// </summary>
        string Description { get; set; }

        bool ClearSetup { get; set; }

        /// <summary>
        /// Counts how many channels are configured.  If a channel's
        /// 'IsConfigured' property is 'true' it is configured.
        /// </summary>
        /// <returns>Number of configured channels</returns>
        int NumberOfConfiguredChannels();

        /// <summary>
        /// Count how many channels we have (regardless if they are configured or not).
        /// </summary>
        /// <returns>Total number of channels</returns>
        int NumberOfChannels();
        /// <summary>
        /// Count how many downloadable channels (i.e. not UART or StreamOut) we have (regardless if they are configured or not).
        /// </summary>
        /// <returns>Total number of downloadable channels</returns>
        int NumberOfDownloadChannels();
        int[] DisplayOrder { get; set; }
        int DasDisplayOrder { get; set; }

        int GetDisplayOrder(uint channelIdx);

        #region Serialization functions        

        void WriteXml(XmlWriter writer);

        void ReadXml(XmlReader reader);

        XmlSchema GetSchema();
        /// <summary>
        /// the Address the DAS receives UDP information from
        /// used to control the OBR-DDR
        /// </summary>
        string UDPReceiveAddress { get; set; }
        #endregion                
    }
}