spinnman.messages.scp.abstract_messages.abstract_scp_request module

class spinnman.messages.scp.abstract_messages.abstract_scp_request.AbstractSCPRequest(sdp_header, scp_request_header, argument_1=None, argument_2=None, argument_3=None, data=None)

Bases: object

Represents an Abstract SCP Request

Parameters:

• sdp_header (spinnman.messages.sdp.sdp_header.SDPHeader) – The SDP header of the request
• scp_request_header (spinnman.messages.scp.scp_request_header.SCPRequestHeader) – The SCP header of the request
• argument_1 (int) – The first argument, or None if no first argument
• argument_2 (int) – The second argument, or None if no second argument
• argument_3 (int) – The third argument, or None if no third argument
• data (bytearray) – The optional data, or None if no data

Raises None:

No known exceptions are raised

Attributes

argument_1	The first argument, or None if no first argument
argument_2	The second argument, or None if no second argument
argument_3	The third argument, or None if no third argument
data	The data, or None if no data
scp_request_header	The SCP request header of the message
sdp_header	The SDP header of the message

Abstract Methods

get_scp_response()

Get an SCP response message to be used to process any response received

Methods

write_scp_request(byte_writer)

Write the scp request to the given writer

Detailed Methods

get_scp_response()

Get an SCP response message to be used to process any response received

Returns:An SCP response, or None if no response is required Return type:spinnman.messages.scp_response.SCPResponse Raises None:No known exceptions are raised

write_scp_request(byte_writer)

Write the scp request to the given writer

Parameters:

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

Returns:

Nothing is returned

Return type:

None

Raises:

• spinnman.exceptions.SpinnmanIOException – If there is an error writing the request
• spinnman.exceptions.SpinnmanInvalidParameterException – If any required values have not been set