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

    /// <summary>
    /// Wrapper class for one filter item.
    /// </summary>
    public class FilterItem : IFilterItem
    {
        /// <summary>
        /// Gets Filter ID.
        /// </summary>
        public int filterId { get; private set; }

        /// <summary>
        /// Gets Type of filter.
        /// </summary>
        public uint filterType { get; private set; }

        /// <summary>
        /// Gets Datasize value.
        /// </summary>
        public int datasize { get; private set; }

        /// <summary>
        /// Gets Mask value.
        /// </summary>
        public uint mask { get; private set; }

        /// <summary>
        /// Gets Pattern value.
        /// </summary>
        public uint pattern { get; private set; }

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

        /// <summary>
        /// Gets TX Flags value.
        /// </summary>
        public uint txFlags { get; private set; }

        /// <summary>
        /// Gets Current protocol.
        /// </summary>
        public Protocols protocol { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="FilterItem" /> class.
        /// </summary>
        /// <param name="msgId">Filter ID</param>
        /// <param name="filterType">Type of filter</param>
        /// <param name="datasize">Datasize value</param>
        /// <param name="mask">Mask value</param>
        /// <param name="pattern">Pattern value</param>
        /// <param name="flow">Flow value</param>
        /// <param name="txFlags">TX Flags value</param>
        /// <param name="protocol">Current protocol</param>
        public FilterItem(
            int msgId,
            uint filterType,
            int datasize,
            uint mask,
            uint pattern,
            uint flow,
            uint txFlags,
            Protocols protocol)
        {
            this.filterId = msgId;
            this.filterType = filterType;
            this.datasize = datasize;
            this.protocol = protocol;
            this.mask = mask;
            this.pattern = pattern;
            this.flow = flow;
            this.txFlags = txFlags;
        }

        /// <summary>
        /// Get string representation of object.
        /// </summary>
        /// <returns>String representation of object.</returns>
        public override string ToString()
        {
#if TRACE_FILTER
            return "filterId=" + this.filterId + ", filterType=" + this.filterType + ", datasize=" + this.datasize + ", protocol=0x" + this.protocol.id.ToString("x2") + ", mask=0x" + this.mask.ToString("x4") + ", pattern=0x" + this.pattern.ToString("x4") + ", flow=0x" + this.flow.ToString("x4") + ", txFlags=0x" + this.txFlags.ToString("x4") + "\r\n";
#else
            return string.Empty;
#endif
        }
    }
}