Package uk.ac.manchester.spinnaker.messages.bmp

Class BMPRequest.PayloadedResponse<T>

java.lang.Object

uk.ac.manchester.spinnaker.messages.scp.SCPResponse

uk.ac.manchester.spinnaker.messages.bmp.BMPRequest.BMPResponse

uk.ac.manchester.spinnaker.messages.bmp.BMPRequest.PayloadedResponse<T>

Type Parameters:

T - The type of the parsed payload.

All Implemented Interfaces:

Supplier<T>

Direct Known Subclasses:

BMPReadMemory.Response, EraseFlash.Response, GetBMPVersion.Response, GetFPGAResetStatus.Response, ReadADC.Response, ReadCANStatus.Response, ReadFPGARegister.Response, ReadIPAddress.Response, ReadSerialFlash.Response, ReadSerialFlashCRC.Response, ReadSerialVector.Response

Enclosing class:

BMPRequest<T extends BMPRequest.BMPResponse>

public abstract static class BMPRequest.PayloadedResponse<T>
extends BMPRequest.BMPResponse
implements Supplier<T>

A BMP response that contains a payload of interest.

Field Summary

Fields inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPResponse

result, sdpHeader, sequence

Constructor Summary

Constructors

Constructor	Description
PayloadedResponse(String operation, SCPCommand command, ByteBuffer buffer)	Make a response object.

Method Summary

Modifier and Type	Method	Description
final T	get()
protected abstract T	parse(ByteBuffer buffer)	Parse the buffer.

Methods inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPResponse

throwIfNotOK

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PayloadedResponse

public PayloadedResponse(String operation,
 SCPCommand command,
 ByteBuffer buffer)
                  throws UnexpectedResponseCodeException

Make a response object.

Parameters:

operation - The operation that this part of.

command - The command that this is a response to.

buffer - The buffer to read the response from.

Throws:

UnexpectedResponseCodeException - If the response is not a success.

Method Details

get

public final T get()

Specified by:

get in interface Supplier<T>

parse

@ForOverride
protected abstract T parse(ByteBuffer buffer)

Parse the buffer.

Parameters:

buffer - The buffer to parse. Will be positioned after the message header.

Returns:

The parsed value.