//-----------------------------------------------------------------------
// <copyright file="XmlClass.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.Misc
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Container class containing classes used when storing data into XML files and retrieving data from XML files.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1052:StaticHolderTypesShouldBeSealed", Justification = "Used for XML data, can't be static.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1053:StaticHolderTypesShouldNotHaveConstructors", Justification = "Used for XML data, can't be static.")]
    public class XmlClass
    {
        /// <summary>
        /// List of capabilities a vehicle can have that's outside OBD-II standard.
        /// </summary>
        public static readonly string[] capabilities =
        {
            "SSM - Subaru Select Monitor",
            "VC1 - Volvo CAN-bus Workaround",
        };

        /// <summary>
        /// Prevents a default instance of the <see cref="XmlClass" /> class from being created.
        /// </summary>
        private XmlClass()
        {
        }

        /// <summary>
        /// For the modes 0x00 to 0xff.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class unititem
        {
            /// <summary>
            /// Gets or sets Text to be displayed. E.g. '°C'.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string description { get; set; }

            /// <summary>
            /// Gets or sets Category for unit. 0 = All modes, 1=Metric mode, 2=Imperial mode.
            /// </summary>
            public int category { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether item is protected against deletion.
            /// </summary>
            public bool secured { get; set; }
        }

        /// <summary>
        /// For the modes 0x00 to 0xff.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class modeitem
        {
            /// <summary>
            /// Gets or sets Mode for item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
            public uint mode_int { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether Secured against delete.
            /// </summary>
            public bool secured { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string vehicle { get; set; }

            /// <summary>
            /// Gets or sets ID for PID group item in decimal form.
            /// </summary>
            public int pidgroupid { get; set; }
        }

        /// <summary>
        /// Gauge record item
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class gaugeitem
        {
            /// <summary>
            /// Gets or sets The number of the gauge.
            /// </summary>
            public uint gaugeNumber { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string gaugetext { get; set; }

            /// <summary>
            /// Gets or sets ID for item in decimal form.
            /// </summary>
            public int pidgroupid { get; set; }

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

            /// <summary>
            /// Gets or sets Unit for value.
            /// </summary>
            public string sensor_unit { get; set; }

            /// <summary>
            /// Gets or sets Data Offset (byte in data record)
            /// </summary>
            public uint sensor_offset { get; set; }

            /// <summary>
            /// Gets or sets Data Offset (byte in data record)
            /// </summary>
            public int sensor_startbit { get; set; }

            /// <summary>
            /// Gets or sets How many steps the scale shall be divided into
            /// </summary>
            public uint majorScaleSteps { get; set; }

            /// <summary>
            /// Gets or sets How many steps between each major step
            /// </summary>
            public uint minorScaleSteps { get; set; }

            /// <summary>
            /// Gets or sets What to divide the value with before display in gauge.
            /// </summary>
            public float divisor { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string digitalGaugetext { get; set; }

            /// <summary>
            /// Gets or sets ID for item in decimal form.
            /// </summary>
            public int digitalPidgroupid { get; set; }

            /// <summary>
            /// Gets or sets Address or PID for item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
            public uint digitalPid_int { get; set; }

            /// <summary>
            /// Gets or sets Unit for value.
            /// </summary>
            public string digitalSensor_unit { get; set; }

            /// <summary>
            /// Gets or sets Data Offset (byte in data record)
            /// </summary>
            public uint digitalSensor_offset { get; set; }

            /// <summary>
            /// Gets or sets Data Offset (byte in data record)
            /// </summary>
            public int digitalSensor_startbit { get; set; }

            /// <summary>
            /// Gets or sets How many steps the scale shall be divided into
            /// </summary>
            public string digitalFormat { get; set; }

            /// <summary>
            /// Gets or sets What to divide the value with before display in gauge.
            /// </summary>
            public float digitalDivisor { get; set; }
        }

        /// <summary>
        /// Gauge record item
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class telltaleitem
        {
            /// <summary>
            /// Gets or sets The number of the gauge.
            /// </summary>
            public uint telltaleGroupNumber { get; set; }

            /// <summary>
            /// Gets or sets The number of the gauge.
            /// </summary>
            public int telltalePriority { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string telltaletext { get; set; }

            /// <summary>
            /// Gets or sets icon file name.
            /// </summary>
            public string telltaleicon { get; set; }

            /// <summary>
            /// Gets or sets ID for item in decimal form.
            /// </summary>
            public int pidgroupid { get; set; }

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

            /// <summary>
            /// Gets or sets Unit for value.
            /// </summary>
            public string sensor_unit { get; set; }

            /// <summary>
            /// Gets or sets Data Offset (byte in data record)
            /// </summary>
            public uint sensor_offset { get; set; }

            /// <summary>
            /// Gets or sets sensor bit number.
            /// </summary>
            public int sensor_bit { get; set; }

            /// <summary>
            /// Gets or sets primary color.
            /// </summary>
            public string primaryColor { get; set; }

            /// <summary>
            /// Gets or sets secondary color.
            /// </summary>
            public string secondaryColor { get; set; }

            /// <summary>
            /// Gets or sets secondary color.
            /// </summary>
            public string flashColor { get; set; }

            /// <summary>
            /// Get the hash code for the item.
            /// </summary>
            /// <returns>Computed hash code.</returns>
            public override int GetHashCode()
            {
                int hc = this.pidgroupid.GetHashCode();

                hc = hc << 7 | hc >> 25;
                hc ^= this.pid_int.GetHashCode();
                hc = hc << 7 | hc >> 25;
                hc ^= this.sensor_offset.GetHashCode();
                hc = hc << 7 | hc >> 25;
                hc ^= this.sensor_bit.GetHashCode();

                return hc;
            }

            /// <summary>
            /// Compare objects.
            /// </summary>
            /// <param name="obj">Object to compare with.</param>
            /// <returns>'true' if equal.</returns>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed.")]
            public override bool Equals(object obj)
            {
                if (obj is XmlClass.telltaleitem)
                {
                    XmlClass.telltaleitem item = (XmlClass.telltaleitem)obj;
                    return (this.pidgroupid == item.pidgroupid
                        && this.pid_int == item.pid_int
                        && this.sensor_offset == item.sensor_offset
                        && this.sensor_bit == item.sensor_bit);
                }

                return false;
            }
        }

        /// <summary>
        /// Grouping of PID list and other lists so it can be re-used
        /// in different contexts. E.g. for both mode 0x01 and 0x02.
        /// How each mode uses the list is depending on the implementation
        /// of the mode.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class pidgroup
        {
            /// <summary>
            /// Gets or sets ID for item in decimal form.
            /// </summary>
            public int id { get; set; }

            /// <summary>
            /// Gets or sets Description text for item.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets Default Mode for item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
            public uint mode_int { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether item has mapping of supported functions.
            /// </summary>
            public bool hasMap { get; set; }

            /// <summary>
            /// List of PID:s.
            /// </summary>
            private List<XmlClass.pidgroup.pidlist> pidlst = new List<XmlClass.pidgroup.pidlist>();

            /// <summary>
            /// Gets or sets PID list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<XmlClass.pidgroup.pidlist> pids
            {
                get { return this.pidlst; }
                set { this.pidlst = value; }
            }

            /// <summary>
            /// Sort the PIDs.
            /// </summary>
            public void sortPids()
            {
                this.pidlst.Sort(Utils.pidlist_sorter);
            }

            /// <summary>
            /// List of PIDs (and TIDs, Addresses etc.)
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class pidlist
            {
                /// <summary>
                /// Gets or sets Description text for item.
                /// </summary>
                public string name { get; set; }

                /// <summary>
                /// Gets or sets Address or PID for item in hex.
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
                public uint pid_int { get; set; }

                /// <summary>
                /// Gets or sets number of bytes for PID.
                /// <para>This is used for SSM when data is more than one byte, default shall be one byte.</para>
                /// </summary>
                public uint pid_bytes { get; set; }

                /// <summary>
                /// Gets or sets a value indicating whether data for this PID can be plotted.
                /// </summary>
                public bool canPlot { get; set; }

                /// <summary>
                /// Gets or sets Height for graph when plotting. Default 150, range 60 to 800.
                /// </summary>
                public uint plotHeight { get; set; }

                /// <summary>
                /// Gets or sets a value indicating whether To control special handling of PID maps in the application.
                /// </summary>
                public bool pidIsMap { get; set; }

                /// <summary>
                /// Gets or sets refresh interval value.
                /// </summary>
                public string refresh { get; set; }

                /// <summary>
                /// List of sensors.
                /// </summary>
                private List<XmlClass.pidgroup.pidlist.sensordata> sensor = new List<XmlClass.pidgroup.pidlist.sensordata>();

                /// <summary>
                /// Gets or sets Sensors.
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
                public List<XmlClass.pidgroup.pidlist.sensordata> sensors
                {
                    get { return this.sensor; }
                    set { this.sensor = value; }
                }

                /// <summary>
                /// Sort the sensor list.
                /// </summary>
                public void sortSensors()
                {
                    this.sensor.Sort(Utils.sensordata_sorter);
                }

                /// <summary>
                /// Configuration data for each sensor corresponding to the PID.
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
                public class sensordata
                {
                    /// <summary>
                    /// Gets or sets ID of sensor.
                    /// </summary>
                    public uint id { get; set; }

                    /// <summary>
                    /// Gets or sets Description text for value.
                    /// </summary>
                    public string name { get; set; }

                    /// <summary>
                    /// Gets or sets Unit for value.
                    /// </summary>
                    public string unit { get; set; }

                    /// <summary>
                    /// Gets or sets Data Offset (byte in data record)
                    /// </summary>
                    public uint offset { get; set; }

                    /// <summary>
                    /// Gets or sets Number of bytes used.
                    /// </summary>
                    public uint count { get; set; }

                    /// <summary>
                    /// Gets or sets Start bit in byte for value.
                    /// </summary>
                    public string startbit { get; set; }

                    /// <summary>
                    /// Gets or sets End bit in byte for value.
                    /// </summary>
                    public string endbit { get; set; }

                    /// <summary>
                    /// Gets or sets Offset at calculation, e.g. -40 for temperature.
                    /// </summary>
                    public double scaleoffset { get; set; }

                    /// <summary>
                    /// Gets or sets Factor to multiply with after application of offset.
                    /// </summary>
                    public double scalefactor { get; set; }

                    /// <summary>
                    /// Gets or sets Max value when presenting in graph.
                    /// </summary>
                    public double presentation_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value when presenting in graph.
                    /// </summary>
                    public double presentation_min { get; set; }

                    /// <summary>
                    /// Gets or sets How the value shall be formatted, empty uses 0.000.
                    /// </summary>
                    public string sensorPresentation_format { get; set; }

                    /// <summary>
                    /// Gets or sets Max value of red zone in graph. Disabled when equal to red_zone_min.
                    /// </summary>
                    public double red_zone_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value of red zone in graph.
                    /// </summary>
                    public double red_zone_min { get; set; }

                    /// <summary>
                    /// Gets or sets Max value of second red zone in graph. Disabled when equal to red_zone_min.
                    /// </summary>
                    public double red2_zone_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value of second red zone in graph.
                    /// </summary>
                    public double red2_zone_min { get; set; }

                    /// <summary>
                    /// Gets or sets Max value of yellow zone in graph. Disabled when equal to yellow_zone_min.
                    /// </summary>
                    public double yellow_zone_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value of yellow zone in graph.
                    /// </summary>
                    public double yellow_zone_min { get; set; }

                    /// <summary>
                    /// Gets or sets Max value of blue zone in graph. Disabled when equal to blue_zone_min.
                    /// </summary>
                    public double blue_zone_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value of blue zone in graph.
                    /// </summary>
                    public double blue_zone_min { get; set; }

                    /// <summary>
                    /// Gets or sets Max value of green zone in graph. Disabled when equal to green_zone_min.
                    /// </summary>
                    public double green_zone_max { get; set; }

                    /// <summary>
                    /// Gets or sets Min value of green zone in graph.
                    /// </summary>
                    public double green_zone_min { get; set; }

                    /// <summary>
                    /// Gets or sets Color to plot with, leave empty to disable plotting.
                    /// </summary>
                    public string plotColor { get; set; }
                }
            }
        }

        /// <summary>
        /// Vehicle record item.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class vehicle
        {
            /// <summary>
            /// Gets or sets ID of vehicle. (Internal to application)
            /// </summary>
            public int id { get; set; }

            /// <summary>
            /// Gets or sets Name of vehicle.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets Brand of vehicle.
            /// </summary>
            public string brand { get; set; }

            /// <summary>
            /// Gets or sets Vehicle Model.
            /// </summary>
            public string model { get; set; }

            /// <summary>
            /// Gets or sets Protocol for vehicle.
            /// </summary>
            public string protocol { get; set; }

            /// <summary>
            /// Gets or sets Communication speed for vehicle.
            /// </summary>
            public uint speed { get; set; }

            /// <summary>
            /// Gets or sets Address of tester for the vehicle.
            /// </summary>
            public string testeraddress { get; set; }

            /// <summary>
            /// Gets or sets Name of OBD codes file specific for the vehicle.
            /// </summary>
            public string obdcodefile { get; set; }

            /// <summary>
            /// Gets or sets Address bits for ISO15765 vehicles.
            /// </summary>
            public int addressbits { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether the vehicle record is protected against deletion.
            /// </summary>
            public bool secured { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether checksum shall be added on ISO9141 vehicle communication.
            /// </summary>
            public bool checksum { get; set; }

            /// <summary>
            /// Gets or sets If a certain initialization procedure is needed.
            /// </summary>
            public int initprocedure { get; set; }

            /// <summary>
            /// List of Tx addresses.
            /// </summary>
            private List<addrlist> txa = new List<addrlist>();

            /// <summary>
            /// Gets or sets Tx address list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<addrlist> txaddrlist
            {
                get { return this.txa; }
                set { this.txa = value; }
            }

            /// <summary>
            /// List of Rx addresses.
            /// </summary>
            private List<addrlist> rxa = new List<addrlist>();

            /// <summary>
            /// Gets or sets Rx address list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<addrlist> rxaddrlist
            {
                get { return this.rxa; }
                set { this.rxa = value; }
            }

            /// <summary>
            /// Sort the TX address list.
            /// </summary>
            public void sortTxAddrList()
            {
                this.txa.Sort(Utils.addrlist_sorter);
            }

            /// <summary>
            /// Sort the RX address list.
            /// </summary>
            public void sortRxAddrList()
            {
                this.rxa.Sort(Utils.addrlist_sorter);
            }

            /// <summary>
            /// List of active message flags for vehicle.
            /// </summary>
            private List<flags> msgflg = new List<flags>();

            /// <summary>
            /// Gets or sets Message flags.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<flags> msgflags
            {
                get { return this.msgflg; }
                set { this.msgflg = value; }
            }

            /// <summary>
            /// List of active connection flags for vehicle.
            /// </summary>
            private List<flags> connflg = new List<flags>();

            /// <summary>
            /// Gets or sets Connection flags.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<flags> connflags
            {
                get { return this.connflg; }
                set { this.connflg = value; }
            }

            /// <summary>
            /// ECU list for vehicle.
            /// </summary>
            private List<ecuData> ecuList = new List<ecuData>();

            /// <summary>
            /// Gets or sets ECU list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<ecuData> ecus
            {
                get { return this.ecuList; }
                set { this.ecuList = value; }
            }

            /// <summary>
            /// Sort the ECU list.
            /// </summary>
            public void sortEcuList()
            {
                this.ecuList.Sort(Utils.eculist_sorter);
            }

            /// <summary>
            /// List of config parameters for vehicle.
            /// </summary>
            private List<configpars> conf = new List<configpars>();

            /// <summary>
            /// Gets or sets Config parameters.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<configpars> config
            {
                get { return this.conf; }
                set { this.conf = value; }
            }

            /// <summary>
            /// List of PID groups for vehicle.
            /// </summary>
            private List<pidgroup> pidgrps = new List<pidgroup>();

            /// <summary>
            /// Gets or sets Pid groups.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<pidgroup> pidgroups
            {
                get { return this.pidgrps; }
                set { this.pidgrps = value; }
            }

            /// <summary>
            /// List of capabilities for vehicle.
            /// </summary>
            private List<capability> caplist = new List<capability>();

            /// <summary>
            /// Gets or sets Capabilities.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<capability> capabilities
            {
                get { return this.caplist; }
                set { this.caplist = value; }
            }

            /// <summary>
            /// Address list item class.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class addrlist
            {
                /// <summary>
                /// Gets or sets Node Address.
                /// </summary>
                public string address { get; set; }

                /// <summary>
                /// Gets or sets a value indicating whether record is Broadcast/Functional address flag.
                /// </summary>
                public bool broadcast { get; set; }
            }

            /// <summary>
            /// Flags item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class flags
            {
                /// <summary>
                /// Gets or sets Flag value.
                /// </summary>
                public string flag { get; set; }
            }

            /// <summary>
            /// ECU item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class ecuData
            {
                /// <summary>
                /// Gets or sets ECU ID (Address)
                /// </summary>
                public string id { get; set; }

                /// <summary>
                /// Gets or sets Name of ECU.
                /// </summary>
                public string name { get; set; }
            }

            /// <summary>
            /// Config parameters item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class configpars
            {
                /// <summary>
                /// Gets or sets Config parameter name.
                /// </summary>
                public string name { get; set; }

                /// <summary>
                /// Gets or sets Config parameter value.
                /// </summary>
                public string value { get; set; }
            }

            /// <summary>
            /// PID group item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class pidgroup
            {
                /// <summary>
                /// Gets or sets ID for item in decimal form.
                /// </summary>
                public int id { get; set; }

                /// <summary>
                /// Gets or sets Description text for item.
                /// </summary>
                public string name { get; set; }

                /// <summary>
                /// Gets or sets Mode for item.
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
                public uint mode_int { get; set; }
            }

            /// <summary>
            /// Capability item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class capability
            {
                /// <summary>
                /// Gets or sets Capability name.
                /// </summary>
                public string name { get; set; }
            }
        }

        /// <summary>
        /// Communication speed record.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class commspeed
        {
            /// <summary>
            /// Gets or sets Name of speed.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets BPS value for speed.
            /// </summary>
            public uint bps { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is common default value (obsoleted)
            /// </summary>
            public bool defaultval { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Default value for J1850
            /// </summary>
            public bool defaultJ1850 { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Default value for ISO9141
            /// </summary>
            public bool defaultISO9141 { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Default value for ISO15765
            /// </summary>
            public bool defaultISO15765 { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Valid value for J1850
            /// </summary>
            public bool validJ1850 { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Valid value for ISO9141
            /// </summary>
            public bool validISO9141 { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is Valid value for ISO15765
            /// </summary>
            public bool validISO15765 { get; set; }

            /// <summary>
            /// Get string representation.
            /// </summary>
            /// <returns>String representation of item</returns>
            public override string ToString()
            {
                return this.name;
            }
        }

        /// <summary>
        /// For definition of parameters supported by SET/GET config.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class parameteritem : IComparable<parameteritem>, IEqualityComparer<parameteritem>
        {
            /// <summary>
            /// Gets or sets ID of parameter.
            /// </summary>
            public uint id { get; set; }

            /// <summary>
            /// Gets or sets Name of parameter.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets Parameter description.
            /// </summary>
            public string description { get; set; }

            /// <summary>
            /// Gets or sets the presentation type to use for the value.
            /// </summary>
            public string presentationType { get; set; }

            /// <summary>
            /// Gets or sets Permitted min value.
            /// </summary>
            public uint min { get; set; }

            /// <summary>
            /// Gets or sets Permitted max value.
            /// </summary>
            public uint max { get; set; }

            /// <summary>
            /// Gets or sets List of protocol ids this parameter is valid for.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Reviewed.")]
            public int[] protocols { get; set; }

            /// <summary>
            /// Gets or sets a value indicating whether record is secured against deletion.
            /// </summary>
            public bool secured { get; set; }

            /// <summary>
            /// Implementation of equals.
            /// </summary>
            /// <param name="r1">Item 1</param>
            /// <param name="r2">Item 2</param>
            /// <returns>'true' if equal.</returns>
            public static bool operator ==(parameteritem r1, parameteritem r2)
            {
                if (((object)r1) == null && ((object)r2) == null)
                {
                    return true;
                }

                if (((object)r1) == null)
                {
                    return false;
                }

                if (((object)r2) == null)
                {
                    return false;
                }

                return r1.Equals(r2);
            }

            /// <summary>
            /// Implementation of not equals.
            /// </summary>
            /// <param name="r1">Item 1</param>
            /// <param name="r2">Item 2</param>
            /// <returns>'true' if not equal.</returns>
            public static bool operator !=(parameteritem r1, parameteritem r2)
            {
                return !(r1 == r2);
            }

            /// <summary>
            /// Implementation of less than.
            /// </summary>
            /// <param name="r1">Item 1</param>
            /// <param name="r2">Item 2</param>
            /// <returns>'true' if less than.</returns>
            public static bool operator <(parameteritem r1, parameteritem r2)
            {
                if (((object)r1) == null && ((object)r2) == null)
                {
                    return false;
                }

                if (((object)r1) == null)
                {
                    return true;
                }

                if (((object)r2) == null)
                {
                    return false;
                }

                return (r1.CompareTo(r2) < 0);
            }

            /// <summary>
            /// Implementation of greater than.
            /// </summary>
            /// <param name="r1">Item 1</param>
            /// <param name="r2">Item 2</param>
            /// <returns>'true' if greater than.</returns>
            public static bool operator >(parameteritem r1, parameteritem r2)
            {
                if (((object)r1) == null && ((object)r2) == null)
                {
                    return false;
                }

                if (((object)r1) == null)
                {
                    return false;
                }

                if (((object)r2) == null)
                {
                    return true;
                }

                return (r1.CompareTo(r2) > 0);
            }

            /// <summary>
            /// Compare with...
            /// </summary>
            /// <param name="obj">Object to compare with.</param>
            /// <returns>Result of compare</returns>
            public int CompareTo(parameteritem obj)
            {
                if (obj == null)
                {
                    return 1;
                }

                int res = 0;
                if (this.id < obj.id)
                {
                    res = -1;
                }

                if (this.id > obj.id)
                {
                    res = 1;
                }

                return res;
            }

            /// <summary>
            /// Check if objects are equal.
            /// </summary>
            /// <param name="obj1">Object 1.</param>
            /// <param name="obj2">Object 2.</param>
            /// <returns>'true' if equal</returns>
            public bool Equals(parameteritem obj1, parameteritem obj2)
            {
                if (obj1 == null && obj2 == null)
                {
                    return true;
                }

                if (obj1 == null)
                {
                    return false;
                }

                if (obj2 == null)
                {
                    return false;
                }

                return obj1.id == obj2.id;
            }

            /// <summary>
            /// Get hashcode for object.
            /// </summary>
            /// <param name="obj">Object to get hashcode for.</param>
            /// <returns>Hashcode value.</returns>
            public int GetHashCode(parameteritem obj)
            {
                if (obj == null)
                {
                    return 0;
                }

                return obj.GetHashCode();
            }

            /// <summary>
            /// Get hashcode for object.
            /// </summary>
            /// <returns>Hashcode value.</returns>
            public override int GetHashCode()
            {
                return (int)this.id;
            }

            /// <summary>
            /// Check if objects are equal.
            /// </summary>
            /// <param name="obj">Object to compare with.</param>
            /// <returns>'true' if equal.</returns>
            public override bool Equals(object obj)
            {
                if (obj != null)
                {
                    parameteritem o2 = (parameteritem)obj;
                    return this.id == o2.id;
                }

                return false;
            }
        }

        /// <summary>
        /// Preference item
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        [Serializable]
        public class preference
        {
            /// <summary>
            /// Gets or sets Name of preference.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// Gets or sets Preference value.
            /// </summary>
            public string value { get; set; }

            /// <summary>
            /// Get hashcode for object.
            /// </summary>
            /// <returns>Calculated hash code.</returns>
            public override int GetHashCode()
            {
                return this.name != null ? this.name.GetHashCode() : 0;
            }

            /// <summary>
            /// Test if equals to object.
            /// </summary>
            /// <param name="obj">Object to compare with.</param>
            /// <returns>'true' if equals.</returns>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed, intentional.")]
            public override bool Equals(object obj)
            {
                if (obj is preference)
                {
                    preference pref = (preference)obj;
                    return (this.name == pref.name);
                }

                return false;
            }
        }

        /// <summary>
        /// Filter record.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class filter
        {
            /// <summary>
            /// Gets or sets Name of filter record.
            /// </summary>
            public string name { get; set; }

            /// <summary>
            /// List of filter items.
            /// </summary>
            private List<filteritem> fitems = new List<filteritem>();

            /// <summary>
            /// Gets or sets Filter item list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<filteritem> filteritems
            {
                get { return this.fitems; }
                set { this.fitems = value; }
            }

            /// <summary>
            /// Filter list items.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class filteritem
            {
                /// <summary>
                /// Gets or sets ID of item.
                /// </summary>
                public uint id { get; set; }

                /// <summary>
                /// Gets or sets Protocol for filter.
                /// </summary>
                public int protocol { get; set; }

                /// <summary>
                /// Gets or sets Type of filter.
                /// </summary>
                public uint type { get; set; }

                /// <summary>
                /// Gets or sets Filter Mask.
                /// </summary>
                public uint mask { get; set; }

                /// <summary>
                /// Gets or sets Filter Pattern.
                /// </summary>
                public uint pattern { get; set; }

                /// <summary>
                /// Gets or sets Filter Flow value.
                /// </summary>
                public uint flow { get; set; }

                /// <summary>
                /// Gets or sets Filter Datasize.
                /// </summary>
                public uint datasize { get; set; }

                /// <summary>
                /// Gets or sets Filter flags.
                /// </summary>
                public uint flags { get; set; }
            }
        }

        /// <summary>
        /// PID Selection record.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class pidselection
        {
            /// <summary>
            /// Gets or sets PID Selection description.
            /// </summary>
            public string description { get; set; }

            /// <summary>
            /// List of PID groups.
            /// </summary>
            private List<XmlClass.pidselection.selectionpidgroup> pidgrps = new List<XmlClass.pidselection.selectionpidgroup>();

            /// <summary>
            /// Gets or sets PID group list.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
            public List<XmlClass.pidselection.selectionpidgroup> pidgroups
            {
                get { return this.pidgrps; }
                set { this.pidgrps = value; }
            }

            /// <summary>
            /// Pid Group item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
            public class selectionpidgroup
            {
                /// <summary>
                /// Gets or sets Pid group
                /// </summary>
                public XmlClass.pidgroup pidGroup { get; set; }

                /// <summary>
                /// PID items list.
                /// </summary>
                private List<pid> piditems = new List<pid>();

                /// <summary>
                /// Gets or sets PID items.
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Used for XML data, can't be readonly.")]
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Used for XML data, can't be readonly.")]
                public List<pid> pids
                {
                    get { return this.piditems; }
                    set { this.piditems = value; }
                }

                /// <summary>
                /// PID item
                /// </summary>
                [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
                public class pid
                {
                    /// <summary>
                    /// Gets or sets PID id.
                    /// </summary>
                    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
                    public uint pid_int { get; set; }

                    /// <summary>
                    /// Gets or sets a value indicating whether PID state is active.
                    /// </summary>
                    public bool active { get; set; }
                }
            }
        }

        /// <summary>
        /// Icon item
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class icon
        {
            /// <summary>
            /// Gets or sets Icon Key.
            /// </summary>
            public string key { get; set; }

            /// <summary>
            /// Gets or sets Icon File.
            /// </summary>
            public string file { get; set; }

            /// <summary>
            /// Gets or sets Icon File.
            /// </summary>
            public string description { get; set; }
        }

        /// <summary>
        /// Mode + PID item
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class selectionModePid
        {
            /// <summary>
            /// List of filter items.
            /// </summary>
            private List<addressItem> addressList = new List<addressItem>();

            /// <summary>
            /// Gets or sets List of destination ECU addresses for message.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Reviewed, intentional")]
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Reviewed, intentional")]
            public List<addressItem> addrList
            {
                get
                {
                    return this.addressList;
                }

                set
                {
                    this.addressList = value;
                }
            }

            /// <summary>
            /// Gets or sets Mode for item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Reviewed.")]
            public uint mode_int { get; set; }

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

            /// <summary>
            /// Gets or sets selected plot group.
            /// </summary>
            public int plotGroup { get; set; }

            /// <summary>
            /// One address item.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional")]
            public class addressItem
            {
                /// <summary>
                /// Gets or sets address field.
                /// </summary>
                public uint address { get; set; }
            }
        }
    }
}