//-----------------------------------------------------------------------
// <copyright file="CanFlags.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.Api
{
    /// <summary>
    /// Definition of one flag item - Message or Connection flag.
    /// </summary>
    public class CanFlags
    {
        /// <summary>
        /// Gets ID of flag.
        /// </summary>
        public uint id { get; private set; }

        /// <summary>
        /// Gets Name of flag.
        /// </summary>
        public string name { get; private set; }

        /// <summary>
        /// Gets a value indicating whether flag set is default value.
        /// </summary>
        public bool defVal { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="CanFlags" /> class.
        /// </summary>
        /// <param name="id">ID of flag</param>
        /// <param name="name">Name of flag set</param>
        /// <param name="defVal">If flag set is default value.</param>
        public CanFlags(uint id, string name, bool defVal)
        {
            this.id = id;
            this.name = name;
            this.defVal = defVal;
        }
    }
}