ReadMemory (SpiNNaker Java Host 7.3.1 API)

java.lang.Object

uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest

uk.ac.manchester.spinnaker.messages.scp.SCPRequest<ReadMemory.Response>

uk.ac.manchester.spinnaker.messages.scp.ReadMemory

All Implemented Interfaces:: SerializableMessage

public class ReadMemory
extends SCPRequest<ReadMemory.Response>

A request to read a region of memory. The response payload is a read-only little-endian ByteBuffer intended to be read once.

Calls sark_cmd_read() in sark_base.c.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

protected class ReadMemory.Response
An SCP response to a request to read a region of memory on a chip.
Field Summary

Fields inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPRequest
argument1, argument2, argument3, BOOT_CHIP, BOOT_MONITOR_CORE, data, NO_DATA, scpRequestHeader

Fields inherited from class uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest
sdpHeader

Constructor Summary

Constructors
Constructor	Description
`ReadMemory(HasChipLocation chip, MemoryLocation address, int size)`
`ReadMemory(HasCoreLocation core, MemoryLocation address, int size)`

Method Summary

Modifier and Type Method Description

ReadMemory.Response getSCPResponse(ByteBuffer buffer)
Parse the response to this message.

Methods inherited from class uk.ac.manchester.spinnaker.messages.scp.SCPRequest
addToBuffer

Methods inherited from class uk.ac.manchester.spinnaker.messages.sdp.SpinnakerRequest
getMessageData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ReadMemory
  
  public ReadMemory(HasCoreLocation core, MemoryLocation address, int size)
  
  Parameters:
  
  core - the core to read via
  
  address - The positive base address to start the read from
  
  size - The number of bytes to read, between 1 and 256
- ReadMemory
  
  public ReadMemory(HasChipLocation chip, MemoryLocation address, int size)
  
  Parameters:
  
  chip - the chip to read via
  
  address - The positive base address to start the read from
  
  size - The number of bytes to read, between 1 and 256
Method Details
- getSCPResponse
  
  public ReadMemory.Response getSCPResponse(ByteBuffer buffer) throws UnexpectedResponseCodeException
  
  Description copied from class: SCPRequest
  
  Parse the response to this message.
  
  Specified by:
  
  getSCPResponse in class SCPRequest<ReadMemory.Response>
  
  Parameters:
  
  buffer - The buffer to parse.
  
  Returns:
  
  The message response.
  
  Throws:
  
  UnexpectedResponseCodeException