//-----------------------------------------------------------------------
// <copyright file="ISimEngine.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
{
    /// <summary>
    /// Simulator engine interface.
    /// </summary>
    public interface ISimEngine
    {
        /// <summary>
        /// Add one row to the traffic table.
        /// </summary>
        /// <param name="direction">Traffic direction and layer level.</param>
        /// <param name="address">Address field.</param>
        /// <param name="mode">Mode field.</param>
        /// <param name="pid">PID field.</param>
        /// <param name="length">Payload length.</param>
        /// <param name="rspStr">Payload data.</param>
        void addRow(rowMode direction, uint address, byte mode, uint pid, uint length, string rspStr);

        /// <summary>
        /// Gets a value indicating whether error code shall be response to invalid Mode/Service.
        /// </summary>
        bool modeErrorCodeFlag { get; }

        /// <summary>
        /// Gets a value indicating whether CAN data shall be padded.
        /// </summary>
        bool padData { get; }

        /// <summary>
        /// Gets a value indicating whether error code shall be response to invalid PIDs/Addresses.
        /// </summary>
        bool pidErrorCodeFlag { get; }
    }
}