//-----------------------------------------------------------------------
// <copyright file="PresentationData.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 Protocol.OBD
{
    using global::SharedObjects.Misc;
    using global::SharedObjects.Protocol.OBD;

    /// <summary>
    /// Wrapper class for presentation data.
    /// </summary>
    public class PresentationData : IPresentationData
    {
        /// <summary>
        /// Gets Source ECU address for the data.
        /// </summary>
        public uint sourceAddress { get; private set; }

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

        /// <summary>
        /// Gets Pid value.
        /// </summary>
        public uint pid { get; private set; }

        /// <summary>
        /// Gets Data label.
        /// </summary>
        public string label { get; private set; }

        /// <summary>
        /// Gets Value unit string.
        /// </summary>
        public string unit { get; private set; }

        /// <summary>
        /// Gets Value string.
        /// </summary>
        public string valueStr { get; private set; }

        /// <summary>
        /// Gets Numeric value (zero if not applicable)
        /// </summary>
        public double value { get; private set; }

        /// <summary>
        /// Gets Timestamp value.
        /// </summary>
        public long t1 { get; private set; }

        /// <summary>
        /// Gets PID Item.
        /// </summary>
        public XmlClass.pidgroup.pidlist pidItem { get; private set; }

        /// <summary>
        /// Gets Sensor item.
        /// </summary>
        public XmlClass.pidgroup.pidlist.sensordata sensor { get; private set; }

        /// <summary>
        /// Gets a value indicating whether Value is potentially invalid.
        /// </summary>
        public bool naFlag { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="PresentationData" /> class.
        /// </summary>
        /// <param name="sourceAddress">Source ECU address for the data.</param>
        /// <param name="mode">Mode byte.</param>
        /// <param name="pid">PID number.</param>
        /// <param name="pidItem">Pid data item.</param>
        /// <param name="sensor">Sensor data item.</param>
        /// <param name="label">Data label.</param>
        /// <param name="unit">Value unit string.</param>
        /// <param name="valueStr">Value string.</param>
        /// <param name="value">Numeric value (zero if not applicable)</param>
        /// <param name="t1">Timestamp value.</param>
        /// <param name="naFlag">Value is potentially invalid.</param>
        public PresentationData(
            uint sourceAddress,
            byte mode,
            uint pid,
            XmlClass.pidgroup.pidlist pidItem,
            XmlClass.pidgroup.pidlist.sensordata sensor,
            string label,
            string unit,
            string valueStr,
            double value,
            long t1,
            bool naFlag)
        {
            this.sourceAddress = sourceAddress;
            this.mode = mode;
            this.pid = pid;
            this.pidItem = pidItem;
            this.sensor = sensor;
            this.label = label;
            this.unit = unit;
            this.valueStr = valueStr;
            this.value = value;
            this.t1 = t1;
            this.naFlag = naFlag;
        }
    }
}