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

    /// <summary>
    /// Interface to data dictionary instance.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1711:IdentifiersShouldNotHaveIncorrectSuffix", Justification = "Reviewed, intentional.")]
    public interface IDataDictionary : IDisposable
    {
        /// <summary>
        /// Gets Record number counter.
        /// </summary>
        int counter { get; }

        /// <summary>
        /// Gets Record number counter.
        /// </summary>
        uint scope { get; }

        /// <summary>
        /// Gets last encountered timestamp.
        /// </summary>
        double timestamp { get; }

        /// <summary>
        /// Gets Dictionary of all loaded modes from file.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "Reviewed, intentional.")]
        IDictionary<uint, IDictionary<uint, IDictionaryItem>> modeDictionary { get; }

        /// <summary>
        /// Called when start of data replay shall occur.
        /// </summary>
        /// <param name="iSimEndPlay">Callback interface to call when end of replay occurs.</param>
        /// <param name="replaySpeed">Replay speed scale factor.</param>
        /// <param name="startTime">Time for start of replay.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "EndPlay", Justification = "Reviewed")]
        void playData(ISimEndPlay iSimEndPlay, double replaySpeed, uint startTime);

        /// <summary>
        /// Called when stop of data replay shall occur.
        /// </summary>
        void stopData();
    }
}