Source code for pcapkit.const.radiotap.mcs_known

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

.. module:: pcapkit.const.radiotap.mcs_known

This module contains the constant enumeration for **Radiotap MCS Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.mcs_known.MCSKnown`.

"""

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__ = ['MCSKnown']




class MCSKnown(EnumRegistry, IntFlag):
    """[MCSKnown] Radiotap MCS Known Flags"""

    #: bandwidth
    MCS_HAVE_BW = 1 << 0

    #: MCS index known (in mcs part of the field)
    MCS_HAVE_MCS = 1 << 1

    #: guard interval
    MCS_HAVE_GI = 1 << 2

    #: HT format
    MCS_HAVE_FMT = 1 << 3

    #: FEC type
    MCS_HAVE_FEC = 1 << 4

    #: STBC known
    MCS_HAVE_STBC = 1 << 5

    #: Ness known (Number of extension spatial streams)
    MCS_HAVE_NESS = 1 << 6

    #: Ness data - bit 1 (MSB) of Number of extension spatial streams
    MCS_NESS_BIT1 = 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 <= 0xFF):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




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

        Args:
            value: Value to get enum item.

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