Uses of Annotation Interface
uk.ac.manchester.spinnaker.utils.UsedInJavadocOnly

Packages that use UsedInJavadocOnly

Package	Description
uk.ac.manchester.spinnaker.alloc	Allocation service for SpiNNaker.
uk.ac.manchester.spinnaker.alloc.allocator	The core allocation system.
uk.ac.manchester.spinnaker.alloc.bmp	The BMP control subsystem.
uk.ac.manchester.spinnaker.alloc.compat	Spalloc v1 compatibility interface.
uk.ac.manchester.spinnaker.alloc.db	Database support for Spalloc server.
uk.ac.manchester.spinnaker.alloc.model	Miscellaneous model classes for spalloc.
uk.ac.manchester.spinnaker.alloc.proxy	SpiNNaker message proxying support code.
uk.ac.manchester.spinnaker.alloc.security	Application security services for new Spalloc.
uk.ac.manchester.spinnaker.alloc.web	The user-facing web interface to the new spalloc service.
uk.ac.manchester.spinnaker.connections	Classes used to model types of connections that talk to SpiNNaker.
uk.ac.manchester.spinnaker.front_end.download	The buffer manager and support classes.
uk.ac.manchester.spinnaker.machine.bean	Beans used to describe a SpiNNaker machine in JSON.
uk.ac.manchester.spinnaker.machine.board	Classes relating to boards in a SpiNNaker machine.
uk.ac.manchester.spinnaker.machine.tags	Describes IPtags and reverse IPtags.
uk.ac.manchester.spinnaker.messages.bmp	Messages that talk to the BMP.
uk.ac.manchester.spinnaker.messages.model	Model support classes for the communication messages.
uk.ac.manchester.spinnaker.messages.scp	The messages of SpiNNaker Control Protocol (SCP).
uk.ac.manchester.spinnaker.spalloc	SpiNNaker old-style machine allocation client.
uk.ac.manchester.spinnaker.storage	Storage management.
uk.ac.manchester.spinnaker.transceiver	How to actually talk to a SpiNNaker machine.
uk.ac.manchester.spinnaker.utils	General utilities for the SpiNNaker runtime.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc

Classes in uk.ac.manchester.spinnaker.alloc with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
static class	SpallocProperties.DataSourceProperties	The properties of a DataSource, describing how to make a database connection.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.allocator

Classes in uk.ac.manchester.spinnaker.alloc.allocator with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
static final class	SpallocAPI.CreateDimensions	A request for a rectangle of boards.

Methods in uk.ac.manchester.spinnaker.alloc.allocator with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
void	SpallocAPI.reportProblem(@IPAddress String address, HasChipLocation coreLocation, String description, Permit permit)	Tells the service that there may be a problem with a board at a particular address.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.bmp

Classes in uk.ac.manchester.spinnaker.alloc.bmp with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
enum	NonBootOperation	Non-boot operations that may be performed on a BMP.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.compat

Classes in uk.ac.manchester.spinnaker.alloc.compat with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
class	V1CompatService	Implementation of the old style Spalloc interface.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.db

Classes in uk.ac.manchester.spinnaker.alloc.db with annotations of type UsedInJavadocOnly

Modifier and Type	Interface	Description
static interface	DatabaseAPI.Query	Wrapping a prepared query to be more suitable for Java 8 onwards.
static interface	DatabaseAPI.Update	Wrapping a prepared update to be more suitable for Java 8 onwards.
final class	Row	A restricted form of result set.
class	SQLQueries	The literal SQL queries used in this package.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.model

Classes in uk.ac.manchester.spinnaker.alloc.model with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
final class	ConnectionInfo	Describes a connection by its chip and hostname.

Constructors in uk.ac.manchester.spinnaker.alloc.model with annotations of type UsedInJavadocOnly

Modifier	Constructor	Description
	BoardIssueReport(Row row)	Create a record from a row.
	MachineTagging(Row row)	Build a basic instance (without tags, which need another query) from the result of SQLQueries.GET_ALL_MACHINES.
	UserRecord(Row row)	Inflate the result of a SQLQueries.GET_USER_DETAILS query (or anything else that includes the same columns) into an object.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.proxy

Methods in uk.ac.manchester.spinnaker.alloc.proxy with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
protected final void	SpinWSHandler.initProxyCore(WebSocketSession session, SpallocAPI.Job job)	Connection established and job looked up.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.security

Classes in uk.ac.manchester.spinnaker.alloc.security with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
class	AppAuthTransformationFilter	A filter to apply authentication transformation as supplied by the LocalAuthenticationProvider.
class	SecurityConfig	The security and administration configuration of the service.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.alloc.web

Classes in uk.ac.manchester.spinnaker.alloc.web with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
@interface	Action	Describes what action a method is to take.
class	BackgroundSupport	Enables a web service class to move processing a request into a background task easily.

Methods in uk.ac.manchester.spinnaker.alloc.web with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
ModelAndView	SystemController.destroyJob(int id, String reason)	Delete a job.
ModelAndView	SystemController.getJobInfo(int id)	Get the view for some job details.
ModelAndView	SystemController.getJobList()	Get the view for the general job list.
ModelAndView	SystemController.getMachineInfo(String machine)	Get the view for some machine details.
ModelAndView	SystemController.getMachineList()	Get the view for the general machine list.
String	SystemController.performLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Log the user out.
ModelAndView	SystemController.powerJob(int id, boolean power)	Set the power of a job.
static URI	ControllerUtils.uri(Object selfCall, Object... objects)	Convert the result of calling a component builder delegate into a URL.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.connections

Classes in uk.ac.manchester.spinnaker.connections with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
class	SCPConnection	An SDP connection to talk SCP (SpiNNaker Control Protocol) to SC&MP on a SpiNNaker system, and to the cores managed by it.
class	SDPConnection	A UDP socket connection that talks SDP (SpiNNaker Datagram Protocol) to SpiNNaker.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.front_end.download

Methods in uk.ac.manchester.spinnaker.front_end.download with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
protected abstract BufferManagerStorage.Region	DataGatherer.getRecordingRegion(Placement placement, int regionID)	Work out exactly where is going to be downloaded.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.machine.bean

Classes in uk.ac.manchester.spinnaker.machine.bean with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
class	ChipBean	Descriptor used for converting JSON into a Chip.
class	ChipDetails	The details of a Chip.
class	LinkBean	A link between two chips.
class	MachineBean	Used to build a Machine from JSON.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.machine.board

Classes in uk.ac.manchester.spinnaker.machine.board with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
final class	BMPLocation	Like a core location, but for BMPs.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.machine.tags

Classes in uk.ac.manchester.spinnaker.machine.tags with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
final class	ReverseIPTag	Used to hold data that is contained within a Reverse IP tag.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.messages.bmp

Classes in uk.ac.manchester.spinnaker.messages.bmp with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
static class	BMPRequest.BMPResponse	Represents an SCP request thats tailored for the BMP connection.
class	BMPSetLED	A request to alter the LEDs on a board managed by a BMP.
class	SerialVector	The data in the serial vector.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.messages.model

Classes in uk.ac.manchester.spinnaker.messages.model with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
enum	CPUState	SARK CPU States.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.messages.scp

Classes in uk.ac.manchester.spinnaker.messages.scp with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
class	ApplicationRun	A request to run an application.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.spalloc

Classes in uk.ac.manchester.spinnaker.spalloc with annotations of type UsedInJavadocOnly

Modifier and Type	Interface	Description
interface	SpallocAPI	The interface exposed by the low-level Spalloc Client.

Constructors in uk.ac.manchester.spinnaker.spalloc with annotations of type UsedInJavadocOnly

Modifier	Constructor	Description
	CreateJob(@uk.ac.manchester.spinnaker.machine.board.ValidTriadX int x, @uk.ac.manchester.spinnaker.machine.board.ValidTriadY int y, @uk.ac.manchester.spinnaker.machine.board.ValidTriadZ int z)	Build a request for a specific board.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.storage

Classes in uk.ac.manchester.spinnaker.storage with annotations of type UsedInJavadocOnly

Modifier and Type	Class	Description
@interface	GeneratesID	Used to document that some DML is expected to generate an ID.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.transceiver

Methods in uk.ac.manchester.spinnaker.transceiver with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
SCPConnection	TransceiverInterface.createScpConnection(ChipLocation chip, InetAddress addr)	Create a connection to a particular instance of SCAMP.

Uses of UsedInJavadocOnly in uk.ac.manchester.spinnaker.utils

Methods in uk.ac.manchester.spinnaker.utils with annotations of type UsedInJavadocOnly

Modifier and Type	Method	Description
static <T, U> List<U>	CollectionUtils.lmap(Collection<T> list, Function<T,U> fun)	Like Stream.map(Function), but for lists/collections.