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

    /// <summary>
    /// Interface to parser for SSM data.
    /// </summary>
    public interface ISsmParser
    {
        /// <summary>
        /// Add data presentation instance.
        /// </summary>
        /// <param name="iDataPresentation">Data presentation instance.</param>
        void addDataPresentation(IDataPresentation iDataPresentation);

        /// <summary>
        /// Add SSM panel instance.
        /// </summary>
        /// <param name="ssmPanel">SSM panel instance to add.</param>
        void addSsmPanel(ISsmPanel ssmPanel);

        /// <summary>
        /// Perform parsing of data.
        /// </summary>
        /// <param name="mode">Message mode.</param>
        /// <param name="payload">Actual data payload.</param>
        /// <param name="requestData">Related transmitted message to help with parsing.</param>
        /// <param name="popNext">Pop next request and send.</param>
        /// <param name="srcAddress">Source address of received data.</param>
        /// <param name="detectedProtocol">Detected protocol by ELM/AGV adapter.</param>
        /// <returns>'true' if successfully parsed by panel.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "3#", Justification = "Reviewed, intentional.")]
        bool parse(uint mode, byte[] payload, IRequestData requestData, ref bool popNext, uint srcAddress, uint detectedProtocol);

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