//-----------------------------------------------------------------------
// <copyright file="RawLogObject.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.CAN.Objects
{
    using System;
    using System.Runtime.Serialization;

    /// <summary>
    /// Container class for raw data.
    /// </summary>
    [Serializable]
    public class RawLogObject
    {
        /// <summary>
        /// Gets Timestamp for object.
        /// </summary>
        public long timestamp { get; private set; }

        /// <summary>
        /// Gets Source Address data
        /// </summary>
        public uint sourceAddress { get; private set; }

        /// <summary>
        /// Gets Mode byte
        /// </summary>
        public byte mode { get; private set; }

        /// <summary>
        /// Gets PID value
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed, intentional")]
        public uint pid_int { get; private set; }

        /// <summary>
        /// Gets Data length
        /// </summary>
        public uint dataLen { get; private set; }

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

        /// <summary>
        /// Serialize the data.
        /// </summary>
        /// <param name="info">Serialization info</param>
        /// <param name="ctx">Serialization context</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "ctx", Justification = "Reviewed, intentional")]
        public void GetObjectData(SerializationInfo info, StreamingContext ctx)
        {
            if (info != null)
            {
                info.AddValue("sourceAddress", this.sourceAddress);
                info.AddValue("mode", this.mode);
                info.AddValue("pid_int", this.pid_int);
                info.AddValue("dataLen", this.dataLen);
                info.AddValue("data", this.data);
            }
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="RawLogObject" /> class.
        /// </summary>
        /// <param name="sourceAddress">Source Address data</param>
        /// <param name="mode">Mode byte</param>
        /// <param name="pid_int">PID value</param>
        /// <param name="dataLen">Data length</param>
        /// <param name="data">Payload data</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed, intentional")]
        public RawLogObject(uint sourceAddress, byte mode, uint pid_int, uint dataLen, byte[] data)
        {
            this.timestamp = DateTime.Now.Ticks;
            this.sourceAddress = sourceAddress;
            this.mode = mode;
            this.pid_int = pid_int;
            this.dataLen = dataLen;
            this.data = data;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="RawLogObject" /> class.
        /// </summary>
        /// <param name="info">Serialization info</param>
        /// <param name="ctx">Serialization context</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "ctx", Justification = "Reviewed, intentional")]
        protected RawLogObject(SerializationInfo info, StreamingContext ctx)
        {
            if (info != null)
            {
                this.sourceAddress = (uint)info.GetValue("sourceAddress", typeof(uint));
                this.mode = (byte)info.GetValue("mode", typeof(byte));
                this.pid_int = (uint)info.GetValue("pid_int", typeof(uint));
                this.dataLen = (uint)info.GetValue("dataLen", typeof(uint));
                this.data = (byte[])info.GetValue("data", typeof(byte[]));
            }
        }
    }
}