Source code for nirfmxwlangen.enums

"""enums.py - Contains enum classes."""

from enum import Enum, IntFlag




class PayloadMacFrameType(Enum):
    """PayloadMacFrameType."""

    GENERAL_FRAME = 0
    r"""Specifies that the MAC frame type is General."""

    DATA_FRAME = 1
    r"""Specifies that the MAC frame type is Data."""

    TRIGGER_FRAME = 2
    r"""Specifies that the MAC frame type is Trigger Frame."""





class TriggerFrameMacPaddingDuration(Enum):
    """TriggerFrameMacPaddingDuration."""

    PADDING_DURATION_0US = 0
    r"""Specifies that there is no padding."""

    PADDING_DURATION_8US = 1
    r"""Specifies that the padding duration is 8us."""

    PADDING_DURATION_16US = 2
    r"""Specifies that the padding duration is 16us."""





class PreambleType80211ah(Enum):
    """PreambleType80211ah."""

    SHORT = 0
    r"""Specifies that the preamble type is S1G_Short."""

    LONG = 1
    r"""Specifies that the preamble type is S1G_Long."""





class DsssPreambleType(Enum):
    """DsssPreambleType."""

    SHORT = 0
    r"""Uses a short preamble as defined in section 18.2.2.2 of IEEE Standard 802.11b-1999."""

    LONG = 1
    r"""Uses a long preamble as defined in section 18.2.2.1 of IEEE Standard 802.11b-1999."""





class PlcpFrameFormat80211n(Enum):
    """PlcpFrameFormat80211n."""

    MIXED = 0
    r"""Specifies that the PLCP frame structure consists of non-HT preamble and header (signal field) followed by high
    throughput (HT) header, preambles, and payload as specified in IEEE Standard 802.11n-2009."""

    GREENFIELD = 1
    r"""Specifies that the PLCP frame structure does not support non-HT, and starts with HT preamble, followed by HT
    signal field and payload."""





class AutoPayloadDataLengthMode(Enum):
    """AutoPayloadDataLengthMode."""

    DISABLED = 0
    r"""Specifies that the WLAN Generation uses the value specified in NIWLANG_PAYLOAD_DATA_LENGTH attribute."""

    L_SIG_LENGTH = 1
    r"""Specifies that the WLAN Generation computes the data length of the MPDUs in an AMPDU of 802.11ax, 802.11be and
    802.11bn Trigger-Based PPDU using the following trigger frame parameters; NIWLANG_L_SIG_LENGTH,
    NIWLANG_PRE_FEC_PADDING_FACTOR, NIWLANG_PE_DISAMBIGUITY, and NIWLANG_LDPC_EXTRA_SYMBOL_SEGMENT attribute."""

    FRAME_DURATION = 2
    r"""Specifies that the WLAN Generation computes the data length of the MPDUs in an AMPDU using the value specified
    in NIWLANG_FRAME_DURATION attribute."""





class AveragePowerReference(Enum):
    """AveragePowerReference."""

    NON_BOOSTED_FIELDS = 0
    r"""Specifies that the WLAN Generation uses the packet fields where no power boosting is applied."""

    POWER_BOOSTED_FIELDS = 1
    r"""Specifies that the WLAN Generation uses the packet fields where power boosting is applied."""

    ENTIRE_PACKET = 2
    r"""Specifies that the WLAN Generation uses the complete packet for computing the average power value."""





class DsssDataRate(Enum):
    """DsssDataRate."""

    DSSS_DATA_RATE_1 = 0
    r"""Specifies a data rate of 1 Mbps, as defined in sections 18.4.6.3 and 18.4.6.4 of IEEE Standard 802.11b-1999."""

    DSSS_DATA_RATE_2 = 1
    r"""Specifies a data rate of 2 Mbps, as defined in sections 18.4.6.3 and 18.4.6.4 of IEEE Standard 802.11b-1999."""

    DSSS_DATA_RATE_5P5_CCK = 2
    r"""Specifies a data rate of 5.5 Mbps complementary code keying (CCK), as defined in section 18.4.6.5 of IEEE
    Standard 802.11b-1999."""

    DSSS_DATA_RATE_5P5_PBCC = 3
    r"""Specifies a data rate of 5.5 Mbps PBCC, as defined in section 18.4.6.6 of IEEE Standard 802.11b-1999."""

    DSSS_DATA_RATE_11_CCK = 4
    r"""Specifies a data rate of 11 Mbps CCK, as defined in section 18.4.6.5 of IEEE Standard 802.11b-1999."""

    DSSS_DATA_RATE_11_PBCC = 5
    r"""Specifies a data rate of 11 Mbps PBCC, as defined in section 18.4.6.6 of IEEE Standard 802.11b-1999."""

    DSSS_DATA_RATE_22 = 6
    r"""Specifies a data rate of 22 Mbps, as defined in section 19.3.3.2 of IEEE Standard 802.11g-2003."""

    DSSS_DATA_RATE_33 = 7
    r"""Specifies a data rate of 33 Mbps, as defined in section 19.3.3.2 of IEEE Standard 802.11g-2003."""





class SigCompressionEnabled(Enum):
    """SigCompressionEnabled."""

    FALSE = 0
    r"""Disables SIG compression."""

    TRUE = 1
    r"""Enables SIG compression."""





class FecCodingType(Enum):
    """FecCodingType."""

    BCC = 0
    r"""Specifies that the FEC coding type is binary convolutional code (BCC)."""

    LDPC = 1
    r"""Specifies that the FEC coding type is low density parity check (LDPC)."""





class GuardIntervalType(Enum):
    """GuardIntervalType."""

    ONE_BY_FOUR = 0
    r"""Specifies that guard interval length is equal to one-fourth of IDFT/DFT period."""

    ONE_BY_EIGHT = 1
    r"""Specifies that guard interval length is equal to one-eighth of IDFT/DFT period."""

    ONE_BY_SIXTEEN = 2
    r"""Specifies that guard interval length is equal to one-sixteenth of the IDFT/DFT period."""





class HybridLOSharingMode(Enum):
    """HybridLOSharingMode."""

    DISABLED = 0
    r"""Hybrid LO sharing is disabled."""

    MODE_0 = 1
    r"""Hybrid LO Sharing Mode 0 is enabled."""





class IdleIntervalMode(Enum):
    """IdleIntervalMode."""

    SPLIT = 0
    r"""Half the idle interval is placed on either side of the burst in the generated waveform."""

    POST_BURST = 1
    r"""Entire idle interval is placed at the end of the burst in the generated waveform."""





class LOFrequencyOffsetMode(Enum):
    """LOFrequencyOffsetMode."""

    AUTO = 0
    r"""Specifies that the LO frequency offset value is computed for optimal EVM performance."""

    USER_DEFINED = 1
    r"""Sets the LO frequency offset value to the value you specified in the NIWLANG_LO_FREQUENCY_OFFSET attribute."""

    DISABLED = 2
    r"""Specifies that the LO frequency offset is not set by the WLAN Generation."""





class LtfSize(Enum):
    """LtfSize."""

    AUTO = -1
    r"""Specifies 4x as HE-LTF/EHT-LTF symbol duration for the guard interval type value of 1/4; or 2x otherwise."""

    LTF_SIZE_4X = 0
    r"""Specifies 4x as the HE-LTF/EHT-LTF symbol duration."""

    LTF_SIZE_2X = 1
    r"""Specifies 2x as the HE-LTF/EHT-LTF symbol duration."""

    LTF_SIZE_1X = 2
    r"""Specifies 1x as the HE-LTF/EHT-LTF symbol duration."""





class MacFrameFormat(Enum):
    """MacFrameFormat."""

    LONG = 0
    r"""Specifies that the MAC frame format is long. The long format follows the general frame structure as defined in
    section 8.2.3 of IEEE Standard 802.11-2012."""

    SHORT = 1
    r"""Specifies that the MAC frame format is short. The short format follows the short frame structure as defined in
    section 8.8 of IEEE Standard P802.11ah/D1.3."""





class MappingMatrixType(Enum):
    """MappingMatrixType."""

    DIRECT = 0
    r"""Refer to the Mapping Matrix Type Values topic."""

    HADAMARD = 1
    r"""Refer to the Mapping Matrix Type Values topic."""

    FOURIER = 2
    r"""Refer to the Mapping Matrix Type Values topic."""

    USER_DEFINED = 3
    r"""Refer to the Mapping Matrix Type Values topic."""





class MidamblePeriodicity(Enum):
    """MidamblePeriodicity."""

    NONE = 0
    r"""Specifies that the midamble is not inserted."""

    TEN_SYMBOLS = 1
    r"""Specifies that the midamble is inserted after every 10 data symbols."""

    TWENTY_SYMBOLS = 2
    r"""Specifies that the midamble is inserted after every 20 data symbols."""





class NominalPacketPadding(Enum):
    """NominalPacketPadding."""

    AUTO = -1
    r"""Specifies that the nominal packet padding is any of the following: 0us, if all the resource units are of size
    less than 242 and DCM is disabled. 0us, if all the resource units are of size less than 106 and DCM is enabled.
    20us, if MCS Index is 12 or 13 or resource unit size is greater than 996*2 or number of spatial streams is
    greater than 8 for 80211BE MIMOOFDM and 80211BN MIMOOFDM. 16us, otherwise."""

    NOMINAL_PACKET_PADDING_0US = 0
    r"""Specifies that the nominal packet padding is 0us."""

    NOMINAL_PACKET_PADDING_8US = 1
    r"""Specifies that the nominal packet padding is 8us."""

    NOMINAL_PACKET_PADDING_16US = 2
    r"""Specifies that the nominal packet padding is 16us."""

    NOMINAL_PACKET_PADDING_20US = 3
    r"""Specifies that the nominal packet padding is 20us if MCS Index is 12 or 13 or resource unit size is greater than
    996*2 or number of spatial streams is greater than 8, and is 16us, otherwise."""





class NonHTModulationMode(Enum):
    """NonHTModulationMode."""

    OFF = 0
    r"""Specifies that the signal is not of non-HT format."""

    ON = 1
    r"""Specifies that the signal is of non-HT format."""





class OfdmDataRate(Enum):
    """OfdmDataRate."""

    OFDM_DATA_RATE_6 = 0
    r"""Specifies a data rate of 1.5 Mbps, 3 Mbps, and 6 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20
    MHz."""

    OFDM_DATA_RATE_9 = 1
    r"""Specifies a data rate of 2.25 Mbps, 4.5 Mbps, and 9 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and
    20 MHz."""

    OFDM_DATA_RATE_12 = 2
    r"""Specifies a data rate of 3 Mbps, 6 Mbps, and 12 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20
    MHz."""

    OFDM_DATA_RATE_18 = 3
    r"""Specifies a data rate of 4.5 Mbps, 9 Mbps, and 18 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and
    20 MHz."""

    OFDM_DATA_RATE_24 = 4
    r"""Specifies a data rate of 6 Mbps, 12 Mbps, and 24 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20
    MHz."""

    OFDM_DATA_RATE_36 = 5
    r"""Specifies a data rate of 9 Mbps, 18 Mbps, and 36 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20
    MHz."""

    OFDM_DATA_RATE_48 = 6
    r"""Specifies a data rate of 12 Mbps, 24 Mbps, and 48 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and
    20 MHz."""

    OFDM_DATA_RATE_54 = 7
    r"""Specifies a data rate of 13.5 Mbps, 27 Mbps, and 54 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and
    20 MHz."""





class PhaseRotationCoefficient1(Enum):
    """PhaseRotationCoefficient1."""

    PLUS_ONE = 0
    r"""Specifies that phase rotation coefficient 1 is +1."""

    MINUS_ONE = 1
    r"""Specifies that phase rotation coefficient 1 is -1."""





class PhaseRotationCoefficient2(Enum):
    """PhaseRotationCoefficient2."""

    PLUS_ONE = 0
    r"""Specifies that phase rotation coefficient 2 is +1."""

    MINUS_ONE = 1
    r"""Specifies that phase rotation coefficient 2 is -1."""





class PhaseRotationCoefficient3(Enum):
    """PhaseRotationCoefficient3."""

    PLUS_ONE = 0
    r"""Specifies that phase rotation coefficient 3 is +1."""

    MINUS_ONE = 1
    r"""Specifies that phase rotation coefficient 3 is -1."""





class PpduType(Enum):
    """PpduType."""

    SU_PPDU = 0
    r"""Specifies that the WLAN Generation generates a single user (SU) PPDU."""

    MU_PPDU = 1
    r"""Specifies that the WLAN Generation generates a multi-user (MU) PPDU."""

    EXTENDED_RANGE_SU_PPDU = 2
    r"""Specifies that the WLAN Generation generates an extended range single user (ER SU) PPDU."""

    TRIGGER_BASED_PPDU = 3
    r"""Specifies that the WLAN Generation generates a trigger-based (TB) PPDU."""

    ELR_PPDU = 4
    r"""Specifies that the WLAN Generation generates an enhanced long range (ELR) PPDU."""





class RUAllocationMode(Enum):
    """RUAllocationMode."""

    INDIVIDUAL = 0
    r"""Users are configured using the NIWLANG_RU_SIZE and the NIWLANG_RU_OFFSET_MRU_INDEX attributes."""

    GROUP = 1
    r"""Users are configured as per the common field of the HE-SIG-B using the NIWLANG_RU_ALLOCATION attribute."""





class RUSize(Enum):
    """RUSize."""

    RU_SIZE_26 = 26
    r"""Specifies that the RU size is 26 subcarriers."""

    RU_SIZE_52 = 52
    r"""Specifies that the RU size is 52 subcarriers."""

    RU_SIZE_106 = 106
    r"""Specifies that the RU size is 106 subcarriers."""

    RU_SIZE_242 = 242
    r"""Specifies that the RU size is 242 subcarriers."""

    RU_SIZE_484 = 484
    r"""Specifies that the RU size is 484 subcarriers."""

    RU_SIZE_996 = 996
    r"""Specifies that the RU size is 996 subcarriers."""

    RU_SIZE_2X996 = 1992
    r"""Specifies that the RU size is 1992 subcarriers."""

    RU_SIZE_4X996 = 3984
    r"""Specifies that the RU size is 3984 subcarriers."""

    RU_SIZE_52_PLUS_26 = 78
    r"""Specifies that the RU size is 78 subcarriers."""

    RU_SIZE_106_PLUS_26 = 132
    r"""Specifies that the RU size is 132 subcarriers."""

    RU_SIZE_484_PLUS_242 = 726
    r"""Specifies that the RU size is 726 subcarriers."""

    RU_SIZE_996_PLUS_484 = 1480
    r"""Specifies that the RU size is 1480 subcarriers."""

    RU_SIZE_996_PLUS_484_PLUS_242 = 1722
    r"""Specifies that the RU size is 1722 subcarriers."""

    RU_SIZE_2X996_PLUS_484 = 2476
    r"""Specifies that the RU size is 2476 subcarriers."""

    RU_SIZE_3X996 = 2988
    r"""Specifies that the RU size is 2988 subcarriers."""

    RU_SIZE_3X996_PLUS_484 = 3472
    r"""Specifies that the RU size is 3472 subcarriers."""





class SpatialMappingMode(Enum):
    """SpatialMappingMode."""

    COMMON = 0
    r"""Specifies that a single global matrix is used for spatial mapping of all users."""

    USER_SPECIFIC = 1
    r"""Specifies that per user spatial mapping is done."""





class Standard(Enum):
    """Standard."""

    STANDARD_80211AG_OFDM = 0
    r"""Corresponds to the OFDM mode defined in IEEE Standard 802.11a-1999 and the extended rate physical layer-OFDM
    (ERP-OFDM) mode defined in IEEE Standard 802.11g-2003."""

    STANDARD_80211J_OFDM = 7
    r"""Corresponds to the OFDM mode defined in IEEE Standard 802.11j 2004."""

    STANDARD_80211P_OFDM = 8
    r"""Corresponds to the OFDM mode defined in IEEE Standard 802.11p 2010."""

    STANDARD_80211BG_DSSS = 1
    r"""Corresponds to all the compulsory and optional modes defined in IEEE Standard 802.11b-1999 and the ERP-packet
    binary convolutional coding (ERP-PBCC) mode in IEEE Standard 802.11g-2003."""

    STANDARD_80211G_DSSS_OFDM = 2
    r"""Corresponds to the optional direct sequence spread spectrum-OFDM (DSSS-OFDM) mode defined in IEEE Standard
    802.11g-2003."""

    STANDARD_80211N_MIMO_OFDM = 3
    r"""Corresponds to IEEE Standard 802.11n-2009. To use this option, you must set the compatibilityVersion parameter
    on the niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_020000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_030000, NIWLANG_VAL_COMPATIBILITY_VERSION_040000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211AC_MIMO_OFDM = 4
    r"""Corresponds to IEEE Standard 802.11ac-2013. To use this option, you must set the compatibilityVersion parameter
    on the niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211AH_MIMO_OFDM = 5
    r"""Corresponds to IEEE P802.11ah/D1.3. To use this option, you must set the compatibilityVersion parameter on the
    niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211AF_MIMO_OFDM = 6
    r"""Corresponds to IEEE Standard 802.11af-2013. To use this option, you must set the compatibilityVersion parameter
    on the niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211AX_MIMO_OFDM = 9
    r"""Corresponds to IEEE P802.11ax/D8.0. To use this option, you must set the compatibilityVersion parameter on the
    niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211BE_MIMO_OFDM = 10
    r"""Corresponds to IEEE P802.11be/D7.0. To use this option, you must set the compatibilityVersion parameter on the
    niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""

    STANDARD_80211BN_MIMO_OFDM = 11
    r"""Corresponds to IEEE P802.11bn/D1.2. To use this option, you must set the compatibilityVersion parameter on the
    niWLANG_OpenSession function to NIWLANG_VAL_COMPATIBILITY_VERSION_030000,
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""





class CompatibilityVersion(Enum):
    """CompatibilityVersion."""

    Version010000 = 10000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_010000."""

    Version020000 = 20000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_020000."""

    Version030000 = 30000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_030000."""

    Version040000 = 40000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_040000."""

    Version050000 = 50000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_050000."""

    Version060000 = 60000
    r"""Indicates that the compatibilityVersion parameter of the niWLANG_OpenSession function is set to
    NIWLANG_VAL_COMPATIBILITY_VERSION_060000."""





class WaveformFileVersion(Enum):
    """WaveformFileVersion."""

    VERSION_1_0 = 0
    r"""Indicates that the waveform file version is set to 1.0."""

    VERSION_2_0 = 1
    r"""Indicates that the waveform file version is set to 2.0."""





class TransmissionMode(Enum):
    """TransmissionMode."""

    DOWNLINK = 0
    r"""Specifies that the transmission mode is downlink (DL)."""

    UPLINK = 1
    r"""Specifies that the transmission mode is uplink (UL)."""





class RUType(Enum):
    """RUType."""

    RRU = 0
    r"""RU Type configured is rRU."""

    DRU = 1
    r"""RU Type configured is dRU."""





class InterferenceMitigationPilotsEnabled(Enum):
    """InterferenceMitigationPilotsEnabled."""

    FALSE = 0
    r"""Specifies that the Interference Mitigation (IM) Pilots are not added in the data field of the PPDU for the
    generated 802.11bn signal."""

    TRUE = 1
    r"""Specifies that the Interference Mitigation (IM) Pilots are added in the data field of the PPDU for the generated
    802.11bn signal."""





class FileOperationMode(Enum):
    """FileOperationMode."""

    OPEN = 0
    r"""Opens an existing waveform file for reading or writing. Returns an error if the file does not exist."""

    OPEN_OR_CREATE = 1
    r"""Opens an existing waveform file if it exists, or creates a new waveform file if it does not exist."""

    CREATE_OR_REPLACE = 2
    r"""Creates a new waveform file. If the file already exists, it is overwritten."""

    CREATE = 3
    r"""Creates a new waveform file. Returns an error if a file with the specified name already exists."""





class HESigBCompressionMode(Enum):
    """HESigBCompressionMode."""

    AUTO = 0
    r"""Specifies that the HE-SIG-B Compression is set automatically."""

    MANUAL = 1
    r"""Specifies that the HE-SIG-B Compression is set according to SIG Compression Enabled property."""





class MultiChassisTClkSynchronizationMode(Enum):
    """MultiChassisTClkSynchronizationMode."""

    AUTO = 0
    r"""Specifies that the Multi-chassis TClk Synchronization is done automatically."""

    TIMING_MODULE = 1
    r"""Specifies that the Multi-chassis TClk Synchronization is done using Timing Module."""





class DualCarrierModulationEnabled(Enum):
    """DualCarrierModulationEnabled."""

    FALSE = 0
    r"""Disables dual carrier modulation (DCM)."""

    TRUE = 1
    r"""Enables dual carrier modulation (DCM)."""





class PayloadDataType(Enum):
    """PayloadDataType."""

    USER_DEFINED_PATTERN = 0
    r"""Specifies that the WLAN Generation uses the sequence of bits that you specify using the
    NIWLANG_PAYLOAD_USER_DEFINED_BITS attribute."""

    PN_SEQUENCE = 1
    r"""Specifies that the WLAN Generation generates the bits using a pseudonoise (PN) sequence with the PN seed and
    order that you specify using the NIWLANG_PAYLOAD_PN_SEED attribute and NIWLANG_PAYLOAD_PN_ORDER attribute."""





class MacHeaderEnabled(Enum):
    """MacHeaderEnabled."""

    FALSE = 0
    r"""Disables MAC header generation."""

    TRUE = 1
    r"""Enables MAC header generation."""





class LockedClockBitEnabled(Enum):
    """LockedClockBitEnabled."""

    FALSE = 0
    r"""Sets the locked clocks bit to 0."""

    TRUE = 1
    r"""Sets the locked clocks bit to 1."""





class HeaderEncoderEnabled(Enum):
    """HeaderEncoderEnabled."""

    FALSE = 0
    r"""Disables convolutional encoding and repeats each input bit twice."""

    TRUE = 1
    r"""Enables convolutional encoding."""





class HeaderInterleaverEnabled(Enum):
    """HeaderInterleaverEnabled."""

    FALSE = 0
    r"""Disables interleaving for the SIGNAL field header."""

    TRUE = 1
    r"""Enables interleaving for the SIGNAL field header."""





class PayloadScramblerEnabled(Enum):
    """PayloadScramblerEnabled."""

    FALSE = 0
    r"""Disables scrambling for the payload."""

    TRUE = 1
    r"""Enables scrambling for the payload."""





class PayloadEncoderEnabled(Enum):
    """PayloadEncoderEnabled."""

    FALSE = 0
    r"""Disables encoding for the payload."""

    TRUE = 1
    r"""Enables encoding for the payload."""





class PayloadInterleaverEnabled(Enum):
    """PayloadInterleaverEnabled."""

    FALSE = 0
    r"""Disables interleaving for the payload."""

    TRUE = 1
    r"""Enables interleaving for the payload."""





class PulseShapingFilterType(Enum):
    """PulseShapingFilterType."""

    RECTANGULAR = 0
    r"""Refer to the Pulse Shaping Filter Type Values help topic in the RFmx WLAN Generation Help."""

    RAISED_COSINE = 1
    r"""Refer to the Pulse Shaping Filter Type Values help topic in the RFmx WLAN Generation Help."""

    ROOT_RAISED_COSINE = 2
    r"""Refer to the Pulse Shaping Filter Type Values help topic in the RFmx WLAN Generation Help."""

    GAUSSIAN = 3
    r"""Refer to the Pulse Shaping Filter Type Values help topic in the RFmx WLAN Generation Help."""





class Channelization(Enum):
    """Channelization."""

    CHANNELIZATION_320_MHZ_1 = 0
    r"""320 MHz channel with channel center frequency numbered 31, 95, and 15."""

    CHANNELIZATION_320_MHZ_2 = 1
    r"""320 MHz channel with channel center frequency numbered 63, 127, and 191."""





class MacQosControlEnabled(Enum):
    """MacQosControlEnabled."""

    FALSE = 0
    r"""Disables the QoS Control field in the MAC header."""

    TRUE = 1
    r"""Enables the QoS Control field in the MAC header."""





class PulseShapingFilterEnabled(Enum):
    """PulseShapingFilterEnabled."""

    FALSE = 0
    r"""Disables the pulse shaping filter."""

    TRUE = 1
    r"""Enables the pulse shaping filter."""





class MacAddress1Enabled(Enum):
    """MacAddress1Enabled."""

    FALSE = 0
    r"""Uses the default MAC Address 1 in the MAC header."""

    TRUE = 1
    r"""Uses the custom MAC Address 1 specified in the NIWLANG_MAC_ADDRESS_1 attribute."""





class MacAddress2Enabled(Enum):
    """MacAddress2Enabled."""

    FALSE = 0
    r"""Uses the default MAC Address 2 in the MAC header."""

    TRUE = 1
    r"""Uses the custom MAC Address 2 specified in the NIWLANG_MAC_ADDRESS_2 attribute."""





class MacAddress3Enabled(Enum):
    """MacAddress3Enabled."""

    FALSE = 0
    r"""Uses the default MAC Address 3 in the MAC header."""

    TRUE = 1
    r"""Uses the custom MAC Address 3 specified in the NIWLANG_MAC_ADDRESS_3 attribute."""





class MacAddress4Enabled(Enum):
    """MacAddress4Enabled."""

    FALSE = 0
    r"""Uses the default MAC Address 4 in the MAC header."""

    TRUE = 1
    r"""Uses the custom MAC Address 4 specified in the NIWLANG_MAC_ADDRESS_4 attribute."""





class MacSequenceControlEnabled(Enum):
    """MacSequenceControlEnabled."""

    FALSE = 0
    r"""Disables the Sequence Control field in the MAC header."""

    TRUE = 1
    r"""Enables the Sequence Control field in the MAC header."""





class MacHTControlEnabled(Enum):
    """MacHTControlEnabled."""

    FALSE = 0
    r"""Disables the HT Control field in the MAC header."""

    TRUE = 1
    r"""Enables the HT Control field in the MAC header."""





class WindowingMethod(Enum):
    """WindowingMethod."""

    CENTERED_AT_SYMBOL_BOUNDARY = 0
    r"""Specifies that the window is applied with its center at the boundary between two OFDM symbols."""

    STARTING_AT_SYMBOL_BOUNDARY = 1
    r"""Specifies that the window is applied with its starting position at the boundary between two OFDM symbols."""





class StbcAllStreamsEnabled(Enum):
    """StbcAllStreamsEnabled."""

    FALSE = 0
    r"""Disables STBC for all spatial streams."""

    TRUE = 1
    r"""Enables STBC for all spatial streams."""





class SwapIAndQEnabled(Enum):
    """SwapIAndQEnabled."""

    FALSE = 0
    r"""Disables the swap of I and Q components."""

    TRUE = 1
    r"""Enables the swap of I and Q components."""





class MacSequenceNumberIncrementEnabled(Enum):
    """MacSequenceNumberIncrementEnabled."""

    FALSE = 0
    r"""Disables automatic incrementing of the MAC sequence number."""

    TRUE = 1
    r"""Enables automatic incrementing of the MAC sequence number for each generated packet."""





class MacFragmentNumberIncrementEnabled(Enum):
    """MacFragmentNumberIncrementEnabled."""

    FALSE = 0
    r"""Disables automatic incrementing of the MAC fragment number."""

    TRUE = 1
    r"""Enables automatic incrementing of the MAC fragment number for each generated packet."""





class AutoHeadroomEnabled(Enum):
    """AutoHeadroomEnabled."""

    FALSE = 0
    r"""Specifies that the WLAN Generation uses the headroom that you specify in the NIWLANG_HEADROOM attribute."""

    TRUE = 1
    r"""Specifies that the WLAN Generation calculates the headroom automatically."""





class RFBlankingEnabled(Enum):
    """RFBlankingEnabled."""

    FALSE = 0
    r"""Specifies that the WLAN Generation does not enable RF blanking."""

    TRUE = 1
    r"""Specifies that the WLAN Generation enables RF blanking. If you select this option, the WLAN Generation completes
    the following actions: the WLAN Generation returns the NIWLANG_RF_BLANKING_MARKER_POSITIONS attribute. the WLAN
    Generation queries the burst start locations and the burst stop locations to get marker positions that can be
    used to toggle the state of RF blanking. These marker positions are generated such that RF blanking is ON during
    the idle interval. The niWLANG_RFSGCreateAndDownloadWaveform function sets the niRFSG RF Blanking Source
    attribute to 'marker0', if it is not set already. The niWLANG_RFSGConfigureScript function modifies the input
    from the script parameter to specify marker events."""





class AllIQImpairmentsEnabled(Enum):
    """AllIQImpairmentsEnabled."""

    FALSE = 0
    r"""Disables all IQ impairments."""

    TRUE = 1
    r"""Enables all IQ impairments."""





class AwgnEnabled(Enum):
    """AwgnEnabled."""

    FALSE = 0
    r"""Disables additive white Gaussian noise (AWGN)."""

    TRUE = 1
    r"""Enables additive white Gaussian noise (AWGN)."""





class MacFcsEnabled(Enum):
    """MacFcsEnabled."""

    FALSE = 0
    r"""Disables the Frame Check Sequence (FCS) field in the MAC header."""

    TRUE = 1
    r"""Enables the Frame Check Sequence (FCS) field in the MAC header."""





class AmpduEnabled(Enum):
    """AmpduEnabled."""

    FALSE = 0
    r"""Disables A-MPDU aggregation. The generated frame is a single MPDU."""

    TRUE = 1
    r"""Enables A-MPDU aggregation. The generated frame is an A-MPDU containing multiple MPDUs."""





class LOSharingEnabled(Enum):
    """LOSharingEnabled."""

    FALSE = 0
    r"""Disables LO sharing."""

    TRUE = 1
    r"""Enables LO sharing."""





class MultiSegmentGenerationMode(Enum):
    """MultiSegmentGenerationMode."""

    SINGLE_GENERATOR = 0
    r"""Specifies that one vector signal generator is used to generate the (80+80) MHz 802.11ac signal."""

    MULTIPLE_GENERATORS = 1
    r"""Specifies that two vector signal generators are used to generate the (80+80) MHz 802.11ac signal."""





class HESigBDualCarrierModulationEnabled(Enum):
    """HESigBDualCarrierModulationEnabled."""

    FALSE = 0
    r"""Disables dual carrier modulation (DCM) in the HE-SIG-B field."""

    TRUE = 1
    r"""Enables dual carrier modulation (DCM) in the HE-SIG-B field."""





class PayloadAutoNumberOfMpdus(Enum):
    """PayloadAutoNumberOfMpdus."""

    FALSE = 0
    r"""Disables automatic computation of the number of MPDUs. Uses the value specified in the
    NIWLANG_PAYLOAD_NUMBER_OF_MPDUS attribute."""

    TRUE = 1
    r"""Enables automatic computation of the number of MPDUs based on the payload data length."""





class MUMimoLtfModeEnabled(Enum):
    """MUMimoLtfModeEnabled."""

    FALSE = 0
    r"""Disables MU-MIMO LTF mode. The HE/EHT-LTF sequence is not pre-coded by the spatial mapping matrix."""

    TRUE = 1
    r"""Enables MU-MIMO LTF mode. The HE/EHT-LTF sequence is pre-coded by the spatial mapping matrix."""





class PreamblePuncturingEnabled(Enum):
    """PreamblePuncturingEnabled."""

    FALSE = 0
    r"""Disables preamble puncturing."""

    TRUE = 1
    r"""Enables preamble puncturing for the generated EHT PPDU."""





class UnframedDataModulationEnabled(Enum):
    """UnframedDataModulationEnabled."""

    FALSE = 0
    r"""Specifies that unframed data modulation is disabled."""

    TRUE = 1
    r"""Specifies that unframed data modulation is enabled."""





class TwoxLdpcEnabled(Enum):
    """TwoxLdpcEnabled."""

    FALSE = 0
    r"""Disables 2x LDPC coding for the EHT PPDU."""

    TRUE = 1
    r"""Enables 2x LDPC coding for the EHT PPDU."""





class UnequalModulationEnabled(Enum):
    """UnequalModulationEnabled."""

    FALSE = 0
    r"""Disables unequal modulation for the EHT PPDU."""

    TRUE = 1
    r"""Enables unequal modulation for the EHT PPDU."""





class UserEnabled(Enum):
    """UserEnabled."""

    FALSE = 0
    r"""Disables this user in the generated PPDU."""

    TRUE = 1
    r"""Enables this user in the generated PPDU."""





class TvhtMode(Enum):
    """TvhtMode."""

    MODE_1 = 0
    r""""""

    MODE_2C = 1
    r""""""

    MODE_2N = 2
    r""""""

    MODE_4C = 3
    r""""""

    MODE_4N = 4
    r""""""





class LOSource(Enum):
    """LOSource."""

    EXTERNAL = 0
    r""""""

    ONBOARD = 2
    r""""""

    SG_SA_SHARED = 3
    r""""""