namespace DTS.Common.Interface.DASFactory.Config
{
    public interface IConfiguration
    {
        /// <summary>
        /// path on pc the IConfiguration device is storing test information to
        /// </summary>
        string TestDirectory { get; set; }
        /// <summary>
        /// returns true if the unit supports discovering channel type [bridge/IEPE]
        /// </summary>
        bool SupportsAutoDetect{ get; }
        /// <summary>
        /// directly query (if possible) if there are any devices connected to this unit
        /// </summary>
        void QueryConnectedDevices();
        /// <summary>
        /// ConfigData object containing the pre-test setup and configuration
        /// of all modules and channels in the hardware.  The object is updated
        /// when <see cref="ConfigurationService">ConfigurationService.Configure(...)</see> is called, and the properties
        /// of the entire DAS unit can be inspected.
        /// </summary>
        IConfigurationData ConfigData { get; set; }
        /// <summary>
        /// DASClockSyncProfile object containing the profile for clock sync for the hardware
        /// The data is updated
        /// when <see cref="ConfigurationService">ConfigurationService.Configure(...)</see> is called, and is only 
        /// applied to units that support the value
        /// </summary>
        ClockSyncProfile DASClockSyncProfile { get; set; }
        /// <summary>
        /// get the display order of this das
        /// allows a das to be display before or after other das
        /// default display order is -1
        /// </summary>
        /// <returns>display order (-1 default)</returns>
        int GetDASDisplayOrder();
        /// <summary>
        /// gets the display order of channels in this das
        /// allows channels to have a different order in display UIs
        /// 
        /// </summary>
        /// <returns></returns>
        int[] GetChannelDisplayOrder();

        /// <summary>
        /// sets the order of the das to be displayed in UIs
        /// should only be called really from FWTU
        /// </summary>
        /// <param name="order"></param>
        void SetDASDisplayOrder(int order);
        /// <summary>
        /// sets the order of channels to be displayed in UIs
        /// should only be called really from FWTU
        /// </summary>
        /// <param name="order"></param>
        void SetChannelDisplayOrder(int[] order);
    }
}