Source code for pacman.utilities.utility_objs.field

# Copyright (c) 2015 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from enum import Enum
import uuid


class SUPPORTED_TAGS(Enum):
    APPLICATION = 0
    ROUTING = 1


class Field(object):
    """
    Field object used in a field constraint for key allocation.
    """

    __slots__ = [
        "_lo",
        "_hi",
        "_value",
        "_tag",
        "_name"
    ]

    def __init__(self, lo, hi, value, tag=SUPPORTED_TAGS.ROUTING, name=None):
        """
        :param int lo: the low bit in the routing table entry for this field
        :param int hi: the high bit in the routing table entry for this field
        :param int value: the value to store in this field
        :param SUPPORTED_TAGS tag: field tag
        :param name: field name
        :type name: str or None
        """
        # pylint: disable=too-many-arguments
        self._lo = lo
        self._hi = hi
        self._value = value
        self._tag = tag
        self._name = uuid.uuid4() if name is None else name

    @property
    def lo(self):
        """
        The low bit in the routing table entry for this field.

        :rtype: int
        """
        return self._lo

    @property
    def hi(self):
        """
        The high bit in the routing table entry for this field.

        :rtype: int
        """
        return self._hi

    @property
    def name(self):
        """
        The field name.

        :rtype: str or ~uuid.UUID
        """
        return self._name

    @name.setter
    def name(self, new_value):
        self._name = new_value

    @property
    def value(self):
        """
        The value to store in this field.

        :rtype: int
        """
        return self._value

    @value.setter
    def value(self, new_value):
        self._value = new_value

    @property
    def tag(self):
        """
        The field tag.

        :rtype: SUPPORTED_TAGS
        """
        return self._tag

    @tag.setter
    def tag(self, new_value):
        self._tag = new_value

    def __repr__(self):
        return (f"Field(lo={self.lo}, hi={self.hi}, value={self.value}, "
                f"tag={self._value}, name={self._name})")

    def __str__(self):
        return self.__repr__()

    def __hash__(self):
        return (self._lo, self._hi, self._value, self._tag,
                self._name).__hash__()

    def __eq__(self, other_field):
        if not isinstance(other_field, Field):
            return False
        return (
            self._lo == other_field.lo and self._hi == other_field.hi and
            self._value == other_field.value and
            self._tag == other_field.tag and
            self._name == other_field.name)

    def __ne__(self, other):
        return not self.__eq__(other)