//-----------------------------------------------------------------------
// <copyright file="IPassThruMsg.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.Api
{
    /// <summary>
    /// Envelope class for one message.
    /// This is much like the PASSTHRU_MSG struct
    /// but is 'pure' C# to avoid unsafe pointers.
    /// </summary>
    public interface IPassThruMsg
    {
        /// <summary>
        /// Gets or sets the array of data.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Intentional for use with DLL API")]
        byte[] Data { get; set; }

        /// <summary>
        /// Gets or sets the size of the data.
        /// </summary>
        int DataSize { get; set; }

        /// <summary>
        /// Gets or sets the index of extra data.
        /// </summary>
        int ExtraDataIndex { get; set; }

        /// <summary>
        /// Gets a value indicating whether this is a message sent from the application,
        /// which is applicable when replaying raw data through the simulator.
        /// </summary>
        bool isSentData { get; }

        /// <summary>
        /// Gets or sets the Protocol ID.
        /// </summary>
        int ProtocolID { get; set; }

        /// <summary>
        /// Gets or sets the RX Status Flags.
        /// </summary>
        int RxStatus { get; set; }

        /// <summary>
        /// Gets or sets the Message Timestamp.
        /// </summary>
        int Timestamp { get; set; }

        /// <summary>
        /// Gets or sets the TX Flags.
        /// </summary>
        int TxFlags { get; set; }

        /// <summary>
        /// Set the values of the struct given as parameter to the values of this object.
        /// Notice that the data area in the struct MUST be allocated to at least
        /// the size of the data area.
        /// </summary>
        /// <param name="pMsg">Pointer to struct to load.</param>
        unsafe void toStruct(PASSTHRU_MSG* pMsg);
    }
}