Source code for pcapkit.const.mh.revocation_trigger

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Revocation Trigger Values
===============================

.. module:: pcapkit.const.mh.revocation_trigger

This module contains the constant enumeration for **Revocation Trigger Values**,
which is automatically generated from :class:`pcapkit.vendor.mh.revocation_trigger.RevocationTrigger`.

"""

from typing import TYPE_CHECKING

from aenum import IntEnum

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

if TYPE_CHECKING:
    from typing import Any

__all__ = ['RevocationTrigger']




class RevocationTrigger(EnumRegistry, IntEnum):
    """[RevocationTrigger] Revocation Trigger Values"""

    #: Unspecified [:rfc:`5846`]
    Unspecified = 0

    #: Administrative Reason [:rfc:`5846`]
    Administrative_Reason = 1

    #: Inter-MAG Handover - same Access Type [:rfc:`5846`]
    Inter_MAG_Handover_same_Access_Type = 2

    #: Inter-MAG Handover - different Access Type [:rfc:`5846`]
    Inter_MAG_Handover_different_Access_Type = 3

    #: Inter-MAG Handover - Unknown [:rfc:`5846`]
    Inter_MAG_Handover_Unknown = 4

    #: User Initiated Session(s) Termination [:rfc:`5846`]
    User_Initiated_Session_Termination = 5

    #: Access Network Session(s) Termination [:rfc:`5846`]
    Access_Network_Session_Termination = 6

    #: Possible Out-of Sync BCE State [:rfc:`5846`]
    Possible_Out_of_Sync_BCE_State = 7

    #: Per-Peer Policy [:rfc:`5846`]
    Per_Peer_Policy = 128

    #: Revoking Mobility Node Local Policy [:rfc:`5846`]
    Revoking_Mobility_Node_Local_Policy = 129



    @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 <= 255):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




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

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 8 <= value <= 127:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 130 <= value <= 249:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 250 <= value <= 255:
            #: Reserved for Testing Purposes Only [:rfc:`5846`]
            return cls._unregistered_member(value, 'Reserved_for_Testing_Purposes_Only')
        return super()._missing_(value)