//-----------------------------------------------------------------------
// <copyright file="PidItemWrapper.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 UserInterface.GUI.OBD
{
    using System.Collections.Generic;
    using global::SharedObjects.GUI;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Wrapper class for PID item and additional data.
    /// </summary>
    public class PidItemWrapper : IPidItemWrapper
    {
        /// <summary>
        /// Gets or sets List of destination ECU addresses for message.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Justification = "Reviewed, intentional.")]
        public IList<uint> addrList { get; set; }

        /// <summary>
        /// Gets actual mode.
        /// </summary>
        public uint actualMode { get; private set; }

        /// <summary>
        /// Gets identifier list mode.
        /// </summary>
        public uint pidMode { get; private set; }

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

        /// <summary>
        /// Gets a value indicating whether all ECU:s shall be checked by default.
        /// </summary>
        public bool defaultChecked { get; private set; }

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

        /// <summary>
        /// List of checked columns.
        /// </summary>
        private List<int> checkedCols = new List<int>();

        /// <summary>
        /// Gets which columns that shall be checked.
        /// </summary>
        public IList<int> checkedColumns
        {
            get
            {
                return this.checkedCols;
            }
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PidItemWrapper" /> class.
        /// </summary>
        /// <param name="actualMode">Actual mode byte value.</param>
        /// <param name="pidMode">PID mode byte value to use.</param>
        /// <param name="pidItem">PID item to wrap.</param>
        /// <param name="defaultChecked">Flag indicating that it shall be checked by default.</param>
        internal PidItemWrapper(uint actualMode, uint pidMode, XmlClass.pidgroup.pidlist pidItem, bool defaultChecked)
        {
            this.actualMode = actualMode;
            this.pidMode = pidMode;
            this.pidItem = pidItem;
            this.defaultChecked = defaultChecked;
            this.plotGroup = 0;
        }
    }
}