//-----------------------------------------------------------------------
// <copyright file="DictionaryItem.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 SimProtocol.SimData
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using SharedObjects.SimData;

    /// <summary>
    /// One dictionary item.
    /// </summary>
    public class DictionaryItem : IDictionaryItem
    {
        /// <summary>
        /// Gets PID for item.
        /// </summary>
        public uint pid { get; private set; }

        /// <summary>
        /// Gets If PID value shall be echoed to caller.
        /// </summary>
        public uint echoPid { get; private set; }

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

        /// <summary>
        /// Initializes a new instance of the <see cref="DictionaryItem" /> class.
        /// </summary>
        /// <param name="pid">PID for item.</param>
        /// <param name="echoPid">If PID value shall be echoed to caller.</param>
        /// <param name="data">Data body to return to caller.</param>
        public DictionaryItem(uint pid, uint echoPid, byte[] data)
        {
            this.pid = pid;
            this.echoPid = echoPid;
            this.data = data;
        }
    }
}