spinnman.messages.sdp.sdp_header module

class spinnman.messages.sdp.sdp_header.SDPHeader(flags=None, tag=None, destination_port=None, destination_cpu=None, destination_chip_x=None, destination_chip_y=None, source_port=None, source_cpu=None, source_chip_x=None, source_chip_y=None)

Bases: object

Represents the header of an SDP message. Each optional parameter in the constructor can be set to a value other than None once, after which it is immutable. It is an error to set a parameter that is not currently None.

Parameters:

• flags (spinnman.messages.sdp.sdp_flag.SDPFlag) – Any flags for the packet
• tag (int) – The ip tag of the packet between 0 and 255, or None if it is to be set later
• destination_port (int) – The destination port of the packet between 0 and 7
• destination_cpu (int) – The destination processor id within the chip between 0 and 31
• destination_chip_x (int) – The x-coordinate of the destination chip between 0 and 255
• destination_chip_y (int) – The y-coordinate of the destination chip between 0 and 255
• source_port (int) – The source port of the packet between 0 and 7, or None if it is to be set later
• source_cpu (int) – The source processor id within the chip between 0 and 31, or None if it is to be set later
• source_chip_x (int) – The x-coordinate of the source chip between 0 and 255, or None if it is to be set later
• source_chip_y – The y-coordinate of the source chip between 0 and 255, or None if it is to be set later

Raises spinnman.exceptions.SpinnmanInvalidParameterException:  

If one ofthe parameters is not valid

Attributes

destination_chip_x	The x-coordinate of the destination chip of the packet
destination_chip_y	The y-coordinate of the destination chip of the packet
destination_cpu	The core on the destination chip
destination_port	The destination port of the packet
flags	The flags of the packet
source_chip_x	The x-coordinate of the source chip of the packet
source_chip_y	The y-coordinate of the source chip of the packet
source_cpu	The core on the source chip
source_port	The source port of the packet
tag	The tag of the packet

Methods

read_sdp_header(byte_reader)	Read an SDP header from a byte_reader
write_sdp_header(byte_writer)	Write the SDP header to a byte_writer

Detailed Methods

read_sdp_header(byte_reader)

Read an SDP header from a byte_reader

Parameters:

byte_reader (spinnman.data.abstract_byte_reader.AbstractByteReader) – The reader to read the data from

Returns:

Nothing is returned

Return type:

None

Raises:

• spinnman.exceptions.SpinnmanIOException – If there is an error reading from the reader
• spinnman.exceptions.SpinnmanInvalidPacketException – If there are too few bytes to read the header
• spinnman.exceptions.SpinnmanInvalidParameterException – If there is an error setting any of the values

write_sdp_header(byte_writer)

Write the SDP header to a byte_writer

Parameters:

byte_writer (spinnman.data.abstract_byte_writer.AbstractByteWriter) – The writer to write the data to

Returns:

Nothing is returned

Return type:

None

Raises:

• spinnman.exceptions.SpinnmanIOException – If there is an error writing to the writer
• spinnman.exceptions.SpinnmanInvalidParameterException – If any of the parameter values have not been set