//-----------------------------------------------------------------------
// <copyright file="IPassThru.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 SharedObjects.Api
{
    using global::SharedObjects.Protocol;

    /// <summary>
    /// In-between interface to handle different implementations of calls to external DLL:s.
    /// </summary>
    public interface IPassThru : IPassThruBase
    {
        /// <summary>
        /// Get list of supported protocols.
        /// </summary>
        /// <returns>Array of supported protocols by the device.</returns>
        Protocols[] getProtocols();

        /// <summary>
        /// Indicate if the interface is a serial device.
        /// <para>
        /// Notice that this also applies to Serial on USB devices.
        /// </para>
        /// </summary>
        /// <returns>'true' if serial device.</returns>
        bool isSerial();

        /// <summary>
        /// Gets the name of the device.
        /// </summary>
        string name { get; }

        /// <summary>
        /// Gets the name of the device.
        /// </summary>
        string code { get; }

        /// <summary>
        /// Flag indicating that the interface has a disconnect bug that needs to be considered.
        /// </summary>
        /// <returns>'true' if bug exists.</returns>
        bool disconnectBug();

        /// <summary>
        /// Get array of connection flags available on the device.
        /// </summary>
        /// <returns>Array of CanFlags.</returns>
        CanFlags[] getConnFlags();

        /// <summary>
        /// Get array of message flags available on the device.
        /// </summary>
        /// <returns>Array of CanFlags.</returns>
        CanFlags[] getMessageFlags();
    }
}