Source code for spinnman.model.enums.diagnostic_filter_emergency_routing_status

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from enum import Enum


class DiagnosticFilterEmergencyRoutingStatus(Enum):
    """ Emergency routing status flags for the diagnostic filters.
        Note that only one has to match for the counter to be incremented
    """
    NORMAL = (0, "Packet is not emergency routed")
    FIRST_STAGE_COMBINED = (1, "Packet is in first hop of emergency route;"
                               " packet should also have been sent here by"
                               " normal routing")
    FIRST_STAGE = (2, "Packet is in first hop of emergency route; packet"
                      " wouldn't have reached this router without emergency"
                      " routing")
    SECOND_STAGE = (3, "Packet is in last hop of emergency route and should"
                       " now return to normal routing")

    def __new__(cls, value, doc=""):
        # pylint: disable=protected-access, unused-argument
        obj = object.__new__(cls)
        obj._value_ = value
        return obj

    def __init__(self, value, doc=""):
        self._value_ = value
        self.__doc__ = doc