Package uk.ac.manchester.spinnaker.front_end.download

Class RecordingRegion

java.lang.Object

uk.ac.manchester.spinnaker.front_end.download.RecordingRegion

public final class RecordingRegion
extends Object

A descriptor about a channel of recording data.

Must match recording_region_t in recording.h in SpiNNFrontEndCommon.

Do not use as a hash key.

Field Summary

Fields

Modifier and Type	Field	Description
final uk.ac.manchester.spinnaker.machine.MemoryLocation	data	The data memory address. (32-bits; unsigned)
final boolean	missing	If there is any missing information. (1-bit)
final long	size	The size of the recording in bytes. (31-bits; unsigned)
static final int	SIZE	Size of the channel data on the machine.
final long	space	The size of the space available. (32-bits; unsigned)

Method Summary

Modifier and Type	Method	Description
static List<RecordingRegion>	getRecordingRegionDescriptors(TransceiverInterface txrx, Placement placement)	Reads the recording regions from the machine.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SIZE

public static final int SIZE

Size of the channel data on the machine.

4 for space, 4 for missing_flag + size, 4 for data

See Also:

• Constant Field Values

space

public final long space

The size of the space available. (32-bits; unsigned)

Not currently used significantly by the Java code

missing

public final boolean missing

If there is any missing information. (1-bit)

size

public final long size

The size of the recording in bytes. (31-bits; unsigned)

data

public final uk.ac.manchester.spinnaker.machine.MemoryLocation data

The data memory address. (32-bits; unsigned)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getRecordingRegionDescriptors

public static List<RecordingRegion> getRecordingRegionDescriptors(TransceiverInterface txrx,
 Placement placement)
                                                           throws IOException,
ProcessException,
InterruptedException

Reads the recording regions from the machine.

Parameters:

txrx - Transceiver to read with

placement - The core to read the data from

Returns:

A list of recording region descriptors read from the machine, one per channel that the recording subsystem there knows about.

Throws:

IOException - If the reading goes wrong

ProcessException - If the data in the read goes wrong

InterruptedException - If communications are interrupted.