//-----------------------------------------------------------------------
// <copyright file="TxMsg.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.Protocol
{
    /// <summary>
    /// Wrapper class for the payload byte array and with some commonly used data.
    /// </summary>
    public class TxMsg
    {
        /// <summary>
        /// Tx mode MODE_CURRENT.
        /// </summary>
        public const byte MODE_CURRENT = 0x01;

        /// <summary>
        /// Tx mode MODE_FREEZE_FRAME.
        /// </summary>
        public const byte MODE_FREEZE_FRAME = 0x02;

        /// <summary>
        /// Tx mode MODE_DTC_READ.
        /// </summary>
        public const byte MODE_DTC_READ = 0x03;

        /// <summary>
        /// Tx mode MODE_DTC_CLEAR.
        /// </summary>
        public const byte MODE_DTC_CLEAR = 0x04;

        /// <summary>
        /// Tx mode MODE_OBD_MID.
        /// </summary>
        public const byte MODE_OBD_MID = 0x06;

        /// <summary>
        /// Tx mode MODE_PENDING_DTC_READ.
        /// </summary>
        public const byte MODE_PENDING_DTC_READ = 0x07;

        /// <summary>
        /// Tx mode MODE_VEHICLE_INFO.
        /// </summary>
        public const byte MODE_VEHICLE_INFO = 0x09;

        /// <summary>
        /// Tx mode MODE_PERMANENT_DTC_READ.
        /// </summary>
        public const byte MODE_PERMANENT_DTC_READ = 0x0a;

        /// <summary>
        /// Tx mode MODE_DTC_READ.
        /// </summary>
        public const byte MODE_ISO14229_DTC_READ = 0x19;

        // Some default payloads.

        /// <summary>
        /// Message GET_SUPPORTED_PIDS
        /// </summary>
        public static readonly byte[] GET_SUPPORTED_PIDS = new byte[] { MODE_CURRENT, 0x00 };

        /// <summary>
        /// Message GET_SUPPORTED_PIDS
        /// </summary>
        public static readonly byte[] GET_SUPPORTED_OBDMIDS = new byte[] { MODE_OBD_MID, 0x00 };
        //// public static readonly byte[] GET_SUPPORTED_OBDMIDS = new byte[] { MODE_OBD_MID, 0x00, 0x20, 0x40, 0x60, 0x80, 0xa0 };

        /// <summary>
        /// Message GET_FREEZEFRAME_PIDS
        /// </summary>
        public static readonly byte[] GET_FREEZEFRAME_PIDS = new byte[] { MODE_FREEZE_FRAME, 0x00, 0x00 };

        /// <summary>
        /// Message GET_DTCS
        /// </summary>
        public static readonly byte[] GET_DTCS = new byte[] { MODE_DTC_READ };

        /// <summary>
        /// Message GET_PENDING_DTCS
        /// </summary>
        public static readonly byte[] GET_PENDING_DTCS = new byte[] { MODE_PENDING_DTC_READ };

        /// <summary>
        /// Message GET_PERMANENT_DTCS
        /// </summary>
        public static readonly byte[] GET_PERMANENT_DTCS = new byte[] { MODE_PERMANENT_DTC_READ };

        /// <summary>
        /// Message CLEAR_DTCS
        /// </summary>
        public static readonly byte[] CLEAR_DTCS = new byte[] { MODE_DTC_CLEAR };

        /// <summary>
        /// Message GET_INFO_PIDS
        /// </summary>
        public static readonly byte[] GET_INFO_PIDS = new byte[] { MODE_VEHICLE_INFO, 0x00 };

        /// <summary>
        /// Message GET_INFO_VIN_MSGS
        /// </summary>
        public static readonly byte[] GET_INFO_VIN_MSGS = new byte[] { MODE_VEHICLE_INFO, 0x01 };

        /// <summary>
        /// Message GET_INFO_VIN
        /// </summary>
        public static readonly byte[] GET_INFO_VIN = new byte[] { MODE_VEHICLE_INFO, 0x02 };

        /// <summary>
        /// Message GET_INFO_CALIBRATION_ID
        /// </summary>
        public static readonly byte[] GET_INFO_CALIBRATION_ID = new byte[] { MODE_VEHICLE_INFO, 0x04 };

        /// <summary>
        /// Message GET_INFO_CALIBRATION
        /// </summary>
        public static readonly byte[] GET_INFO_CALIBRATION = new byte[] { MODE_VEHICLE_INFO, 0x06 };

        /// <summary>
        /// Message SSM_INIT
        /// </summary>
        public static readonly byte[] SSM_INIT = new byte[] { 0xaa };

        /// <summary>
        /// Gets payload data.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Reviewed, intentional.")]
        public byte[] payload { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="TxMsg" /> class.
        /// </summary>
        /// <param name="payload">Payload data.</param>
        public TxMsg(byte[] payload)
        {
            this.payload = payload;
        }

        /// <summary>
        /// Calculate Hashcode.
        /// </summary>
        /// <returns>Calculated Hashcode.</returns>
        public override int GetHashCode()
        {
            int hashCode = 0;

            for (int i = 0; i < this.payload.Length; i++)
            {
                hashCode = (int)(hashCode << 7 | hashCode >> 25);
                hashCode ^= this.payload[i].GetHashCode();
            }

            return hashCode;
        }

        /// <summary>
        /// Compare with another object.
        /// </summary>
        /// <param name="obj">Object to compare with.</param>
        /// <returns>'true' if equal.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "False warning.")]
        public override bool Equals(object obj)
        {
            if (obj is TxMsg)
            {
                TxMsg msg1 = (TxMsg)obj;
                if (msg1.payload is byte[])
                {
                    bool equals = (msg1.payload.Length == this.payload.Length);
                    for (int i = 0; equals && i < this.payload.Length; i++)
                    {
                        equals = (msg1.payload[i] == this.payload[i]);
                    }

                    return equals;
                }
            }

            return false;
        }

        /// <summary>
        /// Get the payload data as a string.
        /// </summary>
        /// <returns>String data.</returns>
        public override string ToString()
        {
            string str = string.Empty;
            foreach (byte b1 in this.payload)
            {
                if (!string.IsNullOrEmpty(str))
                {
                    str += ", ";
                }

                str += "0x" + b1.ToString("x2");
            }

            return str;
        }
    }
}