//-----------------------------------------------------------------------
// <copyright file="DynamicAdapter.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace DynamicApiLoading.Api.Dynamic
{
    using System.Collections.Generic;

    /// <summary>
    /// One instance of an encountered J2534 driver.
    /// </summary>
    public class DynamicAdapter
    {
        /// <summary>
        /// Gets a value indicating whether old J2534 API not supporting the 04.04 format is used.
        /// </summary>
        public bool oldDriver { get; private set; }

        /// <summary>
        /// Gets Registry key name for driver.
        /// </summary>
        public string KeyName { get; private set; }

        /// <summary>
        /// Gets Name of driver.
        /// </summary>
        public string Name { get; private set; }

        /// <summary>
        /// Gets Driver vendor.
        /// </summary>
        public string Vendor { get; private set; }

        /// <summary>
        /// Gets Log file for driver, may be 'null'.
        /// </summary>
        public string LogFile { get; private set; }

        /// <summary>
        /// Gets Configuration application for driver, may be 'null'.
        /// </summary>
        public string ConfigApplication { get; private set; }

        /// <summary>
        /// Gets J2534 library DLL path.
        /// </summary>
        public string FunctionLibrary { get; private set; }

        /// <summary>
        /// Gets RP 1210 library DLL path, may be 'null'.
        /// </summary>
        public string RP1210Library { get; private set; }

        /// <summary>
        /// Gets RP 1210 device ID, may be 'null'.
        /// </summary>
        public int? RP1210DeviceId { get; private set; }

        /// <summary>
        /// Gets List of supported protocols by the driver.
        /// </summary>
        public IList<string> protocols { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="DynamicAdapter" /> class.
        /// </summary>
        /// <param name="oldDriver">'true' if old J2534 API not supporting the 04.04 format.</param>
        /// <param name="KeyName">Registry key name for driver.</param>
        /// <param name="Name">Name of driver.</param>
        /// <param name="Vendor">Driver vendor.</param>
        /// <param name="LogFile">Log file for driver, may be 'null'.</param>
        /// <param name="ConfigApplication">Configuration application for driver, may be 'null'.</param>
        /// <param name="FunctionLibrary">J2534 library DLL path.</param>
        /// <param name="RP1210Library">RP 1210 library DLL path, may be 'null'.</param>
        /// <param name="RP1210DeviceId">RP 1210 device ID, may be 'null'.</param>
        /// <param name="protocols">List of supported protocols by the driver.</param>
        public DynamicAdapter(
            bool oldDriver,
            string KeyName,
            string Name,
            string Vendor,
            string LogFile,
            string ConfigApplication,
            string FunctionLibrary,
            string RP1210Library,
            int? RP1210DeviceId,
            IList<string> protocols)
        {
            this.oldDriver = oldDriver;
            this.KeyName = KeyName;
            this.Name = Name;
            this.Vendor = Vendor;
            this.LogFile = LogFile;
            this.ConfigApplication = ConfigApplication;
            this.FunctionLibrary = FunctionLibrary;
            this.RP1210Library = RP1210Library;
            this.RP1210DeviceId = RP1210DeviceId;
            this.protocols = protocols;
        }

        /// <summary>
        /// Get a string representation of the object.
        /// </summary>
        /// <returns>A string representation of the object.</returns>
        public override string ToString()
        {
            string printedProtocols = string.Empty;
            bool first = true;

            foreach (string protocol in this.protocols)
            {
                if (!first)
                {
                    printedProtocols += ",";
                }
                else
                {
                    first = false;
                }

                printedProtocols += protocol;
            }

            return this.KeyName
                + ": " + this.Name
                + ": " + this.Vendor
                + ": " + this.LogFile
                + ": " + this.ConfigApplication
                + ": " + this.FunctionLibrary
                + ": " + this.RP1210Library
                + ": " + this.RP1210DeviceId
                + ": " + printedProtocols;
        }
    }
}