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

    /// <summary>
    /// Mode parser interface instance.
    /// </summary>
    public interface IModeParser
    {
        /// <summary>
        /// Close the service.
        /// </summary>
        void close();

        /// <summary>
        /// Set up a dictionary of the known Mode/PID combinations.
        /// Notice that the list we use is the list that is filtered depending on preferred units. (Metric or Imperial)
        /// </summary>
        void configureModePidDictionary();

        /// <summary>
        /// Gets Current PID parser instance.
        /// </summary>
        IPidParser pidParser { get; }

        /// <summary>
        /// Receive data to be parsed and presented.
        /// </summary>
        /// <param name="payload">Data to be presented.</param>
        /// <param name="srcAddress">Source address of message.</param>
        /// <param name="detectedProtocol">Detected protocol by ELM/AGV adapter.</param>
        void receiveMessageData(byte[] payload, uint srcAddress, uint detectedProtocol);

        /// <summary>
        /// Register a panel able to receive data.
        /// </summary>
        /// <param name="panel">Panel to register.</param>
        void registerPanel(IDataPanel panel);

        /// <summary>
        /// Set the pending requests that can be performed after the current request has had an answer.
        /// </summary>
        /// <param name="pendingModeRequests">List of pending requests.</param>
        void setPendingRequests(System.Collections.Generic.IList<IRequestData> pendingModeRequests);

        /// <summary>
        /// Remove registered panel.
        /// </summary>
        /// <param name="panel">Panel to unregister.</param>
        void unregisterPanel(IDataPanel panel);
    }
}