spinnman.messages.eieio.data_messages.eieio_with_payload_data_message module

class spinnman.messages.eieio.data_messages.eieio_with_payload_data_message.EIEIOWithPayloadDataMessage(eieio_header, data_reader=None)

Bases: spinnman.messages.eieio.data_messages.eieio_data_message.EIEIODataMessage

An EIEIO message with a payload

Attributes

eieio_header
is_next_element	Determine if there is another element to be read
max_n_elements	The maximum number of elements that can fit in the packet
n_elements	The number of elements in the packet
next_element	The next element to be read, or None if no more elements.
size	The size of the packet with the current contents

Methods

add_key_and_payload(key, payload)

Adds a key and payload to the packet

Detailed Methods

add_key_and_payload(key, payload)

Adds a key and payload to the packet

Parameters:

• key (int) – The key to add
• payload (int) – The payload to add

Raises SpinnmanInvalidParameterException:  

If the key or payload is too big for the format