//-----------------------------------------------------------------------
// <copyright file="IRequestData.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.Misc
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Interface to wrapper class for request data.
    /// </summary>
    public interface IRequestData
    {
        /// <summary>
        /// Gets Destination address for message.
        /// <para>
        /// If 'null' use default address.
        /// </para>
        /// </summary>
        uint? destinationAddress { get; }

        /// <summary>
        /// Gets or sets Creation timestamp.
        /// </summary>
        long timestamp { get; set; }

        /// <summary>
        /// Gets or sets Number of parts received.
        /// </summary>
        int part { get; set; }

        /// <summary>
        /// Gets Actual mode byte value.
        /// </summary>
        byte actualMode { get; }

        /// <summary>
        /// Gets Divisor value set by PID.
        /// </summary>
        int divisor { get; }

        /// <summary>
        /// Gets Received data.
        /// </summary>
        IList<byte> rxData { get; }

        /// <summary>
        /// Gets Message body data.
        /// </summary>
        SharedObjects.Protocol.TxMsg message { get; }

        /// <summary>
        /// Gets PID structure
        /// </summary>
        XmlClass.pidgroup.pidlist pid { get; }

        /// <summary>
        /// Gets or sets Transmit timestamp.
        /// <para>
        /// This is used to determine if it has gone too long without an answer from an ECU.
        /// </para>
        /// </summary>
        long txTimestamp { get; set; }
    }
}