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

    /// <summary>
    /// Interface for wrapper class for presentation data.
    /// </summary>
    public interface IPresentationData
    {
        /// <summary>
        /// Gets Data label.
        /// </summary>
        string label { get; }

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

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

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

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

        /// <summary>
        /// Gets Source ECU address for the data.
        /// </summary>
        uint sourceAddress { get; }

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

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

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

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

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