//-----------------------------------------------------------------------
// <copyright file="IPresentationLayer.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
{
    using System;
    using SharedObjects.GUI;

    /// <summary>
    /// Presentation layer interface.
    /// </summary>
    public interface IPresentationLayer : IDisposable
    {
        /// <summary>
        /// Gets Counter value.
        /// </summary>
        int counter { get; }

        /// <summary>
        /// Gets Dictionary data.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "Reviewed, intentional")]
        System.Collections.Generic.IDictionary<uint, System.Collections.Generic.IDictionary<uint, SharedObjects.SimData.IDictionaryItem>> modeDictionary { get; }

        /// <summary>
        /// Load logged data to replay.
        /// </summary>
        /// <param name="dataFile">Data file containing log data.</param>
        /// <param name="srcAddr">Source address for ECU to simulate.</param>
        void loadReplayData(string dataFile, uint srcAddr);

        /// <summary>
        /// Load static data.
        /// </summary>
        /// <param name="dataFile">Data file with static ECU data.</param>
        void loadStaticData(string dataFile);

        /// <summary>
        /// Start replay of data from logged file.
        /// </summary>
        /// <param name="iSimEndPlay">Callback interface to indicate end of file.</param>
        /// <param name="replaySpeed">Factor for speed to replay data with</param>
        /// <param name="startTime">Start timestamp in seconds for data relative to start of file.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "EndPlay", Justification = "Reviewed, intentional")]
        void playData(ISimEndPlay iSimEndPlay, double replaySpeed, uint startTime);

        /// <summary>
        /// Gets Scope value.
        /// </summary>
        uint scope { get; }

        /// <summary>
        /// Stop replay of data.
        /// </summary>
        void stopData();

        /// <summary>
        /// Gets Current timestamp in seconds for data relative to start of file.
        /// </summary>
        double timestamp { get; }
    }
}