kytos / python-openflow

    @property

    def value(self):

        """Return this type's value.

        Returns:

            object: The value of an enum, bitmask, etc.

        """

        if self.isenum():

            if isinstance(self._value, self.enum_ref):

                return self._value.value

            return self._value

        elif self.is_bitmask():

            return self._value.bitmask

        else:

            return self._value

    def pack(self, value=None):

        r"""Pack the value as a binary representation.

        Considering an example with UBInt8 class, that inherits from

        GenericType:

        >>> from pyof.foundation.basic_types import UBInt8

        >>> objectA = UBInt8(1)

        >>> objectB = 5

        >>> objectA.pack()

        b'\x01'

        >>> objectA.pack(objectB)

        b'\x05'

        Args:

            value: If the value is None, then we will pack the value of the

                current instance. Otherwise, if value is an instance of the

                same type as the current instance, then we call the pack of the

                value object. Otherwise, we will use the current instance pack

                method on the passed value.

        Returns:

            bytes: The binary representation.

        Raises:

            :exc:`~.exceptions.BadValueException`: If the value does not

                fit the binary format.

        """

        if isinstance(value, type(self)):

            return value.pack()

    def get_size(self, value=None):

        """Return the ip address size in bytes.

        Args:

            value: In structs, the user can assign other value instead of

                this class' instance. Here, in such cases, ``self`` is a class

                attribute of the struct.

        Returns:

            int: The address size in bytes.

        """

        return 4

    def __deepcopy__(self, memo):

        """Improve deepcopy speed."""

        return IPAddress(address=self._value, netmask=self.netmask)

class HWAddress(GenericType):

    """Defines a hardware address."""

    # pylint: disable=useless-super-delegation

    def __init__(self, hw_address='00:00:00:00:00:00'):

        """Create a HWAddress with the parameters below.

        Args:

            hw_address (bytes): Hardware address. Defaults to

                '00:00:00:00:00:00'.

        """

        super().__init__(hw_address)

    def pack(self, value=None):

        """Pack the value as a binary representation.

        If the passed value (or the self._value) is zero (int), then the pack

        return DPID(dpid=self._value)

class Char(GenericType):

    """Build a double char type according to the length."""

    def __init__(self, value=None, length=0):

        """Create a Char with the optional parameters below.

        Args:

            value: The character to be build.

            length (int): Character size.

        """

        super().__init__(value)

        self.length = length

        self._fmt = '!{}{}'.format(self.length, 's')

    def pack(self, value=None):

        """Pack the value as a binary representation.

        Returns:

            bytes: The binary representation.

        Raises:

            struct.error: If the value does not fit the binary format.

        """

        if isinstance(value, type(self)):

        return Char(value=self._value, length=self.length)

class IPAddress(GenericType):

    """Defines a IP address."""

    netmask = UBInt32()

    max_prefix = UBInt32(32)

    def __init__(self, address="0.0.0.0/32", netmask=None):

        """Create an IPAddress with the parameters below.

        Args:

            address (str): IP Address using ipv4. Defaults to '0.0.0.0/32'

        """

        if '/' in address:

            address, netmask = address.split('/')

        else:

            netmask = 32 if netmask is None else netmask

        super().__init__(address)

        self.netmask = int(netmask)

    def pack(self, value=None):

        """Pack the value as a binary representation.

        If the value is None the self._value will be used to pack.

        Args:

            value (str): IP Address with ipv4 format.

        Returns:

            bytes: The binary representation.

        Raises:

            struct.error: If the value does not fit the binary format.