//-----------------------------------------------------------------------
// <copyright file="IPidParser.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.GUI;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Interface for class that parses PID data.
    /// </summary>
    public interface IPidParser
    {
        /// <summary>
        /// Add data presentation instance.
        /// </summary>
        /// <param name="iDataPresentation">Data presentation instance.</param>
        void addDataPresentation(IDataPresentation iDataPresentation);

        /// <summary>
        /// Sets Data panel instance.
        /// </summary>
        /// <param name="obdDataPanel">Data panel instance.</param>
        void addPidReceiver(IObdDataPanel obdDataPanel);

        /// <summary>
        /// Parse PID.
        /// </summary>
        /// <param name="pidItem">PID Item.</param>
        /// <param name="mode">Mode byte.</param>
        /// <param name="frame">Frame number for freeze frame data.</param>
        /// <param name="pidPayload">Payload to parse.</param>
        /// <param name="srcAddress">Source address of received data.</param>
        /// <returns>'true' if it's OK to pop the next message to send and send it.</returns>
        bool parsePid(XmlClass.pidgroup.pidlist pidItem, byte mode, byte frame, byte[] pidPayload, uint srcAddress);

        /// <summary>
        /// Remove data presentation instance.
        /// </summary>
        /// <param name="iDataPresentation">Data presentation instance.</param>
        void removeUi(IDataPresentation iDataPresentation);

        /// <summary>
        /// Set gauge presentation instance.
        /// </summary>
        /// <param name="iGaugePresentation">Gauge presentation instance.</param>
        void setGaugePresentation(IGaugePresentation iGaugePresentation);
    }
}