// -----------------------------------------------------------------------
// <copyright file="AbstractSessionLayer.cs" company="">
// TODO: Update copyright text.
// </copyright>
// -----------------------------------------------------------------------

namespace SharedObjects
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading;
    using SharedObjects;
    using SharedObjects.Protocol;

    /// <summary>
    /// Common parts for the SessionLayer.
    /// </summary>
    public abstract class AbstractSessionLayer : ISessionLayerToPresentation, ISessionLayer
    {
        /// <summary>
        /// Set the simulation engine.
        /// </summary>
        /// <param name="iSimEngine">Simulation engine instance.</param>
        public abstract void setSimEngine(ISimEngine iSimEngine);

        /// <summary>
        /// Clean up.
        /// </summary>
        public abstract void Dispose();

        /// <summary>
        /// Add presentation layer instance.
        /// </summary>
        /// <param name="iPresentationLayer">Presentation layer to add</param>
        public abstract void addPresentationLayer(IPresentationLayerToSession iPresentationLayer);

        /// <summary>
        /// Remove presentation layer instance.
        /// </summary>
        /// <param name="iPresentationLayer">Presentation layer to remove.</param>
        public abstract void removePresentationLayer(IPresentationLayerToSession iPresentationLayer);

        /// <summary>
        /// Send data on CAN.
        /// </summary>
        /// <param name="outAddress">Target address.</param>
        /// <param name="response">Payload data.</param>
        /// <param name="dataLen">Payload data length.</param>
        public abstract void sendData(uint outAddress, IList<byte> response, uint dataLen);

        /// <summary>
        /// Receive one data packet.
        /// </summary>
        /// <param name="id">Address value.</param>
        /// <param name="data0">Payload data.</param>
        /// <param name="flags">Flags value.</param>
        /// <param name="res1">RES1 Value.</param>
        /// <param name="res2">RES2 Value.</param>
        public abstract void receiveData(uint id, byte[] data0, ushort flags, ulong res1, ulong res2);

        /// <summary>
        /// Set CAN bus communicator instance.
        /// </summary>
        /// <param name="iObdCommunicator">CAN bus communicator instance.</param>
        public abstract void setObdCommunicator(IObdCommunicator iObdCommunicator);
    }
}