Index (SpiNNaker Front End Interface 7.3.1 API)

A B C D E F G H I L M N P R S T U V
All Classes|All Packages

A

awaitAndCombineExceptions() - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor.Tasks: Wait for all tasks to finish.

B

BasicExecutor - Class in uk.ac.manchester.spinnaker.front_end: A thread pool designed for simple task execution with combining of exceptions.
BasicExecutor(int) - Constructor for class uk.ac.manchester.spinnaker.front_end.BasicExecutor: Create an instance of the pool.
BasicExecutor.SimpleCallable - Interface in uk.ac.manchester.spinnaker.front_end: The type of task that this executor can run.
BasicExecutor.Tasks - Class in uk.ac.manchester.spinnaker.front_end: Holds the future results of the submitted tasks.
BoardLocal(HasChipLocation) - Constructor for class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport.BoardLocal
BoardLocalSupport - Class in uk.ac.manchester.spinnaker.front_end: A class for making things easier to do on a per-board basis.
BoardLocalSupport(ProxyAwareStorage, Machine) - Constructor for class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport
BoardLocalSupport.BoardLocal - Class in uk.ac.manchester.spinnaker.front_end: A context that can be pushed to state in logging what board is the root.

C

call() - Method in interface uk.ac.manchester.spinnaker.front_end.BasicExecutor.SimpleCallable: Does an action, or throws an exception if it fails to do so.
close() - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor
close() - Method in class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport.BoardLocal
close() - Method in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer
close() - Method in class uk.ac.manchester.spinnaker.front_end.download.DataReceiver
close() - Method in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegionDataGatherer
close() - Method in class uk.ac.manchester.spinnaker.front_end.dse.FastExecuteDataSpecification
close() - Method in class uk.ac.manchester.spinnaker.front_end.dse.HostExecuteDataSpecification
close() - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRetriever
CommandLineInterface - Class in uk.ac.manchester.spinnaker.front_end: The main command line interface.
CommandLineInterface.DbFileParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <dbFile> parameter.
CommandLineInterface.DsFileParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <dsFile> parameter.
CommandLineInterface.GatherersParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <gatherFile> parameter.
CommandLineInterface.IobufDirParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <iobufDir> parameter.
CommandLineInterface.IobufMapParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <iobufMapFile> parameter.
CommandLineInterface.LogfileParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <logfile> parameter.
CommandLineInterface.MachineParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <machineFile> parameter.
CommandLineInterface.PlacementsParam - Class in uk.ac.manchester.spinnaker.front_end: Argument handler for the <placementFile> parameter.
Constants - Class in uk.ac.manchester.spinnaker.front_end: Miscellaneous constants that can be overridden by system properties.
Constants() - Constructor for class uk.ac.manchester.spinnaker.front_end.Constants
CORE_DATA_SDRAM_BASE_TAG - Static variable in class uk.ac.manchester.spinnaker.front_end.Constants: Base SDRAM tag to use for core data.

D

data - Variable in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: The data memory address.
DataGatherer - Class in uk.ac.manchester.spinnaker.front_end.download: Implementation of the SpiNNaker Fast Data Download Protocol.
DataGatherer(ProxyAwareStorage, Machine) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Create an instance of the protocol implementation.
DataReceiver - Class in uk.ac.manchester.spinnaker.front_end.download: Stripped down version of the BufferManager for early testing.
DataReceiver(Machine, BufferManagerStorage) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.DataReceiver: Creates a new mini Buffer Manager.
db - Variable in class uk.ac.manchester.spinnaker.front_end.dse.ExecuteDataSpecification: The database.
DirectDataGatherer - Class in uk.ac.manchester.spinnaker.front_end.download: Deprecated.
This class uses an unimplemented API call that needs to be fixed but hasn't been yet. It also assumes that there are no shared regions.
DirectDataGatherer(Machine, BufferManagerStorage) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.DirectDataGatherer: Deprecated.

Create a data gatherer.
downloadRecordingChannelsViaClassicTransfer(CommandLineInterface.PlacementsParam, CommandLineInterface.MachineParam, CommandLineInterface.DbFileParam, CommandLineInterface.LogfileParam) - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: Download data without using data gatherer cores.
downloadRecordingChannelsViaMonitorStreaming(CommandLineInterface.GatherersParam, CommandLineInterface.MachineParam, CommandLineInterface.DbFileParam, CommandLineInterface.LogfileParam) - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: Download data using data gatherer cores.
DownloadRegion - Class in uk.ac.manchester.spinnaker.front_end.download.request: A non-recording region to be downloaded.
DownloadRegion() - Constructor for class uk.ac.manchester.spinnaker.front_end.download.request.DownloadRegion
DownloadRegion(int, long, int) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.request.DownloadRegion: Constructs a new download region.

E

ExecuteDataSpecification - Class in uk.ac.manchester.spinnaker.front_end.dse: Common base for executing data specifications.
ExecuteDataSpecification(Machine, DSEDatabaseEngine) - Constructor for class uk.ac.manchester.spinnaker.front_end.dse.ExecuteDataSpecification

F

FastExecuteDataSpecification - Class in uk.ac.manchester.spinnaker.front_end.dse: Implementation of the Data Specification Executor that uses the Fast Data In protocol to upload the results to a SpiNNaker machine.
FastExecuteDataSpecification(Machine, List<Gather>, File, DSEDatabaseEngine) - Constructor for class uk.ac.manchester.spinnaker.front_end.dse.FastExecuteDataSpecification: Create an instance of this class.

G

gather(List<Gather>) - Method in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Download he contents of the regions that are described through the data gatherers.
Gather - Class in uk.ac.manchester.spinnaker.front_end.download.request: Data speed up packet gatherer description.
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.DbFileParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.DsFileParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.GatherersParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.IobufDirParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.IobufMapParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.LogfileParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.MachineParam
get() - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface.PlacementsParam
getAddress() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.DownloadRegion
getBase() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Vertex: Get the recording region base address.
getBaseAddress() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Vertex: Get the recording region base address.
getDataForPlacements(List<Placement>) - Method in class uk.ac.manchester.spinnaker.front_end.download.DataReceiver: Gets the data for a list of placements.
getDataForPlacementsParallel(List<Placement>, int) - Method in class uk.ac.manchester.spinnaker.front_end.download.DataReceiver: Gets the data for a list of placements in parallel.
getDownloadRegions() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Vertex
getErrors() - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.NotableMessages
getIndex() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.DownloadRegion
getIptag() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather
getJob() - Method in class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport
getLabel() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Vertex
getMonitors() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather
getNextTransactionId() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather: Sets the transaction ID to a new value and returns that new value.
getP() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather
getP() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Monitor
getP() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Placement
getPlacements() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Monitor
getRecordedRegionIds() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Vertex: Get the recording region IDs that have been recorded using buffering.
getRecordingRegion(Placement, int) - Method in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Work out exactly where is going to be downloaded.
getRecordingRegion(Placement, int) - Method in class uk.ac.manchester.spinnaker.front_end.download.DirectDataGatherer: Deprecated.
getRecordingRegion(Placement, int) - Method in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegionDataGatherer
getRecordingRegionDescriptors(TransceiverInterface, Placement) - Static method in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: Reads the recording regions from the machine.
getRequestDetails() - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRequest
getSize() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.DownloadRegion
getTransceiver() - Method in class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport
getVertex() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Placement
getWarnings() - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.NotableMessages
getX() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather
getX() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Monitor
getX() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Placement
getY() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather
getY() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Monitor
getY() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Placement

H

HostExecuteDataSpecification - Class in uk.ac.manchester.spinnaker.front_end.dse: Executes the host based data specification.
HostExecuteDataSpecification(Machine, DSEDatabaseEngine) - Constructor for class uk.ac.manchester.spinnaker.front_end.dse.HostExecuteDataSpecification: Create a high-level DSE interface.

I

IobufRequest - Class in uk.ac.manchester.spinnaker.front_end.iobuf: The request to read some IOBUFs off a SpiNNaker system.
IobufRequest(Map<String, List<List<Integer>>>) - Constructor for class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRequest
IobufRetriever - Class in uk.ac.manchester.spinnaker.front_end.iobuf: Retrieves and processes IOBUFs.
IobufRetriever(ProxyAwareStorage, Machine, int) - Constructor for class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRetriever: Create a IOBUF retriever.

L

LIST - Static variable in class uk.ac.manchester.spinnaker.front_end.download.request.Gather: Type reference for deserializing a list of gatherer descriptions.
LIST - Static variable in class uk.ac.manchester.spinnaker.front_end.download.request.Placement: Type reference for deserializing a list of placements.
loadCores(boolean) - Method in class uk.ac.manchester.spinnaker.front_end.dse.HostExecuteDataSpecification: Execute all application data specifications that a particular connection knows about, storing back in the database the information collected about those executions.
loadCores(List<Gather>) - Method in class uk.ac.manchester.spinnaker.front_end.dse.FastExecuteDataSpecification: Execute all application data specifications that a particular connection knows about, storing back in the database the information collected about those executions.
log - Static variable in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Logger for the gatherer.
LogControl - Class in uk.ac.manchester.spinnaker.front_end: Utilities for working with the log.

M

machine - Variable in class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport: The description of the SpiNNaker machine.
main(String...) - Static method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: The main command line interface.
missing - Variable in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: If there is any missing information.
Monitor - Class in uk.ac.manchester.spinnaker.front_end.download.request: Extra monitor core information.

N

NotableMessages - Class in uk.ac.manchester.spinnaker.front_end.iobuf: The result of the IOBUF retrieval operations.
NotableMessages(List<String>, List<String>) - Constructor for class uk.ac.manchester.spinnaker.front_end.iobuf.NotableMessages

P

PARALLEL_PROPERTY - Static variable in class uk.ac.manchester.spinnaker.front_end.Constants: The name of the system property defining the number of parallel tasks that should be executed at once.
PARALLEL_SIZE - Static variable in class uk.ac.manchester.spinnaker.front_end.Constants: The number of parallel tasks that should be executed at once.
Placement - Class in uk.ac.manchester.spinnaker.front_end.download.request: Vertex placement information.
processTasksInParallel(Collection<DSEStorage.Ethernet>, Function<DSEStorage.Ethernet, BasicExecutor.SimpleCallable>) - Method in class uk.ac.manchester.spinnaker.front_end.dse.ExecuteDataSpecification: Run the tasks in parallel.

R

RecordingRegion - Class in uk.ac.manchester.spinnaker.front_end.download: A descriptor about a channel of recording data.
RecordingRegionDataGatherer - Class in uk.ac.manchester.spinnaker.front_end.download: A data gatherer that pulls the data from a recording region.
RecordingRegionDataGatherer(Machine, BufferManagerStorage) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.RecordingRegionDataGatherer: Create a data gatherer.
retrieveIobufContents(IobufRequest, File) - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRetriever: Retrieve and translate some IOBUFs.
retrieveIobufContents(CoreSubsets, File, File) - Method in class uk.ac.manchester.spinnaker.front_end.iobuf.IobufRetriever: Retrieve and translate some IOBUFs.
retrieveIOBUFs(CommandLineInterface.MachineParam, CommandLineInterface.IobufMapParam, CommandLineInterface.DbFileParam, CommandLineInterface.LogfileParam, CommandLineInterface.IobufDirParam) - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: Retrieve IOBUFs in parallel.
runDSEForAppCoresUploadingViaMonitorStreaming(CommandLineInterface.GatherersParam, CommandLineInterface.MachineParam, CommandLineInterface.DsFileParam, CommandLineInterface.LogfileParam, Optional<File>) - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: Run the data specifications in parallel.
runDSEUploadingViaClassicTransfer(Machine, File, File, Boolean) - Method in class uk.ac.manchester.spinnaker.front_end.CommandLineInterface: Run the data specifications in parallel.

S

setLogfile(File) - Static method in class uk.ac.manchester.spinnaker.front_end.LogControl: Initialise the logging subsystem to log to the correct file.
size - Variable in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: The size of the recording in bytes.
SIZE - Static variable in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: Size of the channel data on the machine.
SMALL_RETRIEVE_PROPERTY - Static variable in class uk.ac.manchester.spinnaker.front_end.Constants: The name of the system property defining the threshold at which retrieves are switched over to the fast (data-speed-up-packet-gatherer based) retrieve protocol.
SMALL_RETRIEVE_THRESHOLD - Static variable in class uk.ac.manchester.spinnaker.front_end.Constants: Retrieves of data that is less than this many bytes are done via a normal SCAMP memory read.
space - Variable in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion: The size of the space available.
storage - Variable in class uk.ac.manchester.spinnaker.front_end.BoardLocalSupport: A storage object that is aware of proxies.
storeData(BufferManagerStorage.Region, ByteBuffer) - Method in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Store the data retrieved from a region No guarantee is made about which thread will call this method.
storeData(BufferManagerStorage.Region, ByteBuffer) - Method in class uk.ac.manchester.spinnaker.front_end.download.DirectDataGatherer: Deprecated.
storeData(BufferManagerStorage.Region, ByteBuffer) - Method in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegionDataGatherer
submitTasks(Iterable<BasicExecutor.SimpleCallable>) - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor: Submit some tasks to the pool.
submitTasks(Collection<T>, Function<T, BasicExecutor.SimpleCallable>) - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor: Submit some tasks to the pool.
submitTasks(Stream<T>, Function<T, BasicExecutor.SimpleCallable>) - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor: Submit some tasks to the pool.
submitTasks(Stream<BasicExecutor.SimpleCallable>) - Method in class uk.ac.manchester.spinnaker.front_end.BasicExecutor: Submit some tasks to the pool.

T

toString() - Method in class uk.ac.manchester.spinnaker.front_end.download.RecordingRegion
toString() - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Monitor
txrx - Variable in class uk.ac.manchester.spinnaker.front_end.download.DataGatherer: Transceiver to talk to the machine.

U

uk.ac.manchester.spinnaker.front_end - package uk.ac.manchester.spinnaker.front_end: The front-end interface to the Java implementation of the SpiNNaker host libraries.
uk.ac.manchester.spinnaker.front_end.download - package uk.ac.manchester.spinnaker.front_end.download: The buffer manager and support classes.
uk.ac.manchester.spinnaker.front_end.download.request - package uk.ac.manchester.spinnaker.front_end.download.request: Classes used to describe the JSON requests to the data transfer code.
uk.ac.manchester.spinnaker.front_end.dse - package uk.ac.manchester.spinnaker.front_end.dse: Data specification execution interface.
uk.ac.manchester.spinnaker.front_end.iobuf - package uk.ac.manchester.spinnaker.front_end.iobuf: Utility for retrieving IOBUF contents.
updateTransactionIdFromMachine(TransceiverInterface) - Method in class uk.ac.manchester.spinnaker.front_end.download.request.Gather: sets the transaction id from the machine.

V

Vertex - Class in uk.ac.manchester.spinnaker.front_end.download.request: Vertex recording region information.
Vertex(String, long, int[], DownloadRegion[]) - Constructor for class uk.ac.manchester.spinnaker.front_end.download.request.Vertex: Create a minimal vertex, possibly using an unmarshaller.

A B C D E F G H I L M N P R S T U V
All Classes|All Packages