//-----------------------------------------------------------------------
// <copyright file="FT_PARITY.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar and Future Technology Devices International Limited. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace FtdiApi.Constants
{
    /// <summary>
    /// Permitted parity values for FTDI devices
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1516:ElementsMustBeSeparatedByBlankLine", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1201:ElementsMustAppearInTheCorrectOrder", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1121:UseBuiltInTypeAlias", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1202:ElementsMustBeOrderedByAccess", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1305:FieldNamesMustNotUseHungarianNotation", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1306:FieldNamesMustBeginWithLowerCaseLetter", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:CurlyBracketsMustNotBeOmitted", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1310:FieldNamesMustNotContainUnderscore", Justification = "Reviewed.")]
    public class FT_PARITY
    {
        /// <summary>
        /// No parity
        /// </summary>
        public const byte FT_PARITY_NONE = 0x00;

        /// <summary>
        /// Odd parity
        /// </summary>
        public const byte FT_PARITY_ODD = 0x01;

        /// <summary>
        /// Even parity
        /// </summary>
        public const byte FT_PARITY_EVEN = 0x02;

        /// <summary>
        /// Mark parity
        /// </summary>
        public const byte FT_PARITY_MARK = 0x03;

        /// <summary>
        /// Space parity
        /// </summary>
        public const byte FT_PARITY_SPACE = 0x04;
    }
}