Source code for spinnman.messages.scp.scp_response_header

import struct

from spinnman.messages.scp.enums import SCPResult


class SCPResponseHeader(object):
    """ Represents the header of an SCP Response
    """

    def __init__(self, result=None, sequence=None):
        """
        """
        self._result = result
        self._sequence = sequence

    @property
    def result(self):
        """ The result of the SCP response

        :return: The result
        :rtype: :py:class:`spinnman.messages.scp.scp_result.SCPResult`
        """
        return self._result

    @property
    def sequence(self):
        """ The sequence number of the SCP response

        :return: The sequence number of the packet, between 0 and 65535
        :rtype: int
        """
        return self._sequence

    @staticmethod
    def from_bytestring(data, offset):
        """ Read a header from a bytestring

        :param data: The bytestring to read from
        :type data: str
        :param offset:
        """
        result, sequence = struct.unpack_from("<2H", data, offset)
        return SCPResponseHeader(SCPResult(result), sequence)