Source code for pcapkit.const.radiotap.usig_common_known

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Radiotap U-SIG Common Known Flags
=======================================

.. module:: pcapkit.const.radiotap.usig_common_known

This module contains the constant enumeration for **Radiotap U-SIG Common Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.usig_common_known.USIGCommonKnown`.

"""

from typing import TYPE_CHECKING

from aenum import IntFlag

from pcapkit.corekit.enum import EnumRegistry
from pcapkit.utilities.exceptions import EnumValueError

if TYPE_CHECKING:
    from typing import Any

__all__ = ['USIGCommonKnown']




class USIGCommonKnown(EnumRegistry, IntFlag):
    """[USIGCommonKnown] Radiotap U-SIG Common Known Flags"""

    #: PHY version identifier known
    EHT_USIG_COMMON_PHY_VER_KNOWN = 1 << 0

    #: BW known
    EHT_USIG_COMMON_BW_KNOWN = 1 << 1

    #: UL/DL known
    EHT_USIG_COMMON_UL_DL_KNOWN = 1 << 2

    #: BSS Color known
    EHT_USIG_COMMON_BSS_COLOR_KNOWN = 1 << 3

    #: TXOP known
    EHT_USIG_COMMON_TXOP_KNOWN = 1 << 4

    #: bad U-SIG CRC
    EHT_USIG_COMMON_BAD_USIG_CRC = 1 << 5

    #: validate bits checked
    EHT_USIG_COMMON_VALIDATE_BITS_CHECKED = 1 << 6

    #: validate bits OK
    EHT_USIG_COMMON_VALIDATE_BITS_OK = 1 << 7



    @classmethod
    def _validate_value(cls, value: 'Any') -> 'None':
        """Reject ``value`` unless it passes the range check :meth:`_missing_` makes.

        Overrides :meth:`~pcapkit.corekit.enum.EnumLookup._validate_value`
        with that check and the message it raises, so
        :meth:`~pcapkit.corekit.enum.EnumRegistry.register` refuses exactly the
        values :meth:`~pcapkit.corekit.enum.EnumLookup.get` refuses, in the
        same words (:issue:`1816`).

        Args:
            value: Value about to be looked up or minted.

        Raises:
            EnumValueError: If ``value`` fails that check. A
                :exc:`ValueError`, so an ``except ValueError`` caller is
                unaffected.

        """
        if not (isinstance(value, int) and 0 <= value <= 0xFFFFFFFF):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




    @classmethod
    def _missing_(cls, value: 'int') -> 'USIGCommonKnown':
        """Lookup function used when value is not found.

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 0xFFFFFFFF):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        return super()._missing_(value)