Index (SpiNNaker NMPI Service Shared Model 7.3.1 API)

A C D E F G H I J P R S T U V
All Classes|All Packages

A

addOutput(String, int, String, InputStream) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Add to the output files of a job.
addProvenance(int, List<String>, String) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Add to the provenance of a job.
appendLog(int, String) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Add to the log of a job.
APPLICATION_JSON - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The media type for JSON.
APPLICATION_OCTET_STREAM - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The media type for Binary data.
APPLICATION_ZIP - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The media type of ZIP files.

C

checkMachineLease(int, int) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Check if the job is still allocated to a machine.
ChipCoordinates - Class in uk.ac.manchester.spinnaker.nmpi.model.machine: Represents a set of coordinates of a chip within a machine.
ChipCoordinates(int, int, int) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.machine.ChipCoordinates: Create a new set of ChipCoordinates.
compareTo(SpinnakerMachine) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Compare to another machine; order by name then by version.

D

DataItem - Class in uk.ac.manchester.spinnaker.nmpi.model.job.nmpi: A reference to some data to be moved into or out of a Job.
DataItem() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.DataItem: Creates an empty item of data.
DataItem(String) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.DataItem: Make an instance that wraps a URL.

E

equals(Object) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Check for equality with another machine.
Error - uk.ac.manchester.spinnaker.nmpi.model.job.Status: Indicates that the process has stopped with an error.
extendJobMachineLease(int, double) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Extend the lease of the job.

F

Finished - uk.ac.manchester.spinnaker.nmpi.model.job.Status: Indicates that the process has completed successfully.

G

getArea() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine
getBmpDetails() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the BMP details of the machine.
getBoard() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.ChipCoordinates: Get the board containing the chip.
getCabinet() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.ChipCoordinates: Get the cabinet containing the frame containing the board containing the chip.
getChipCoordinates(int, String, int, int) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get a description of where a chip actually is.
getClassName() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Get the name of the class of the element.
getCode() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the code to be executed.
getCollab() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the ID of the collaboratory in which the job is created.
getCommand() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the command used to execute the job.
getElements() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTrace: Get the elements.
getFileName() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Get the name of the file of the element.
getFrame() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.ChipCoordinates: Get the frame containing the board containing the chip.
getHardwareConfig() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the hardware configuration.
getHardwareConfiguration() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Get the hardwareConfiguration.
getHardwarePlatform() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the hardware platform.
getHeight() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the height of the machine in chips.
getId() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Get the ID of the job.
getId() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the ID of the job.
getInputData() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the URLs of input data.
getJobMachine(int, int, int, int, double) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get a machine for running a job.
getJobProcessManager() - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get the implementation code of the Job Process Manager.
getLargestJobMachine(int, double) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get the largest machine that could run a job.
getLineNumber() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Get the line number of the element.
getMachine() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Get the machine to run the job on.
getMachineName() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the name of the machine.
getMethodName() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Get the name of the method of the element.
getnBoards() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the number of boards in the machine.
getNextJob(String) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get the job manager to find out what its next job will be.
getParameters() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Get the parameters of the job.
getSetupScript() - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Get the setup script to be executed.
getSetupScript() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Get the setup script.
getUrl() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Get the URL of the job to send results and status to.
getUrl() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.DataItem: Get the URL of the item of data.
getUserId() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Get the ID of the user who created the job.
getUserScript() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Get the user script.
getVersion() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the version of the machine.
getWidth() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Gets the width of the machine in chips.
getWorkingDirectory() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Get the workingDirectory.

H

hashCode() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Generate a hash code based on name and version.

I

isAllocated() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobMachineAllocated: Determine if the job is allocated.

J

Job - Class in uk.ac.manchester.spinnaker.nmpi.model.job.nmpi: A NMPI job.
Job() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job
JOB_PROCESS_MANAGER - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The name of the file we like to serve up when giving people a remote process manager.
JobMachineAllocated - Class in uk.ac.manchester.spinnaker.nmpi.model.job: Indicates whether a machine was allocated for a job.
JobMachineAllocated() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.JobMachineAllocated: Empty for serialisation.
JobMachineAllocated(boolean) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.JobMachineAllocated: Create an instance.
JobManagerInterface - Interface in uk.ac.manchester.spinnaker.nmpi.model.job: JAX-RS interface to a Job for the purposes of management.
JobParameters - Interface in uk.ac.manchester.spinnaker.nmpi.model.job: A type of Job to be executed.
JobParametersTypeName - Annotation Type in uk.ac.manchester.spinnaker.nmpi.model.job: Identifies the unique type name of a JobParameters implementation.
JobSpecification - Class in uk.ac.manchester.spinnaker.nmpi.model.job: The specification for a job.
JobSpecification() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Constructor for serialisation.
JobSpecification(SpinnakerMachine, JobParameters, int, String) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Create the specification for running a job.

P

parse(String) - Static method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Creates a new Spinnaker Machine by parsing the name of a machine.
PATH - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The path to the interface.
PyNNJobParameters - Class in uk.ac.manchester.spinnaker.nmpi.model.job.pynn: Represents the parameters required for a PyNN job.
PyNNJobParameters() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Create an empty parameters for serialisation.
PyNNJobParameters(String, String, String, Map<String, Object>) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Create a description of the job parameters for a PyNN job.

R

releaseMachine(int, String) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Drop the allocation of a machine to a job.
RemoteStackTrace - Class in uk.ac.manchester.spinnaker.nmpi.model.job: Represents a stack trace provided remotely.
RemoteStackTrace() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTrace: Create a basic remote stack trace without stack elements.
RemoteStackTrace(Throwable) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTrace: Create a basic remote stack trace from an exception.
RemoteStackTrace(List<RemoteStackTraceElement>) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTrace: Create a basic remote stack trace from a list of elements.
RemoteStackTraceElement - Class in uk.ac.manchester.spinnaker.nmpi.model.job: Represents a stack trace provided remotely.
RemoteStackTraceElement() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Constructor for serialisation.
RemoteStackTraceElement(StackTraceElement) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Create an element of a remote stack trace from a standard stack trace element.
Running - uk.ac.manchester.spinnaker.nmpi.model.job.Status: Indicates that the process is currently running.

S

setAllocated(boolean) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobMachineAllocated: Set the job allocation status.
setBmpDetails(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the BMP details of the machine.
setClassName(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Sets the className.
setCode(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the code.
setCollab(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the collab.
setCommand(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the command.
setElements(List<RemoteStackTraceElement>) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTrace: Set the elements.
setFileName(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Sets the fileName.
setHardwareConfig(Map<String, Object>) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the hardwareConfig.
setHardwareConfiguration(Map<String, Object>) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Sets the hardwareConfiguration.
setHardwarePlatform(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the hardwarePlatform.
setHeight(int) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the height of the machine in chips.
setId(int) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Sets the ID.
setId(Integer) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the id.
setInputData(List<DataItem>) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the inputData.
setJobError(String, int, String, String, String, List<String>, RemoteStackTrace) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Mark the job as finished with an error.
setJobFinished(String, int, String, String, List<String>) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Mark the job as successfully finished.
setLineNumber(int) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Sets the lineNumber.
setMachine(SpinnakerMachine) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Sets the machine.
setMachineName(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the name of the machine.
setMachinePower(int, String, boolean) - Method in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: Set the power status of a job's machine.
setMethodName(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Sets the methodName.
setnBoards(int) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the number of boards in the machine.
setParameters(JobParameters) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Sets the parameters.
setSetupScript(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Set the setup script.
SETUP_SCRIPT - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The name of the setup script.
setUrl(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.JobSpecification: Sets the URL.
setUrl(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.DataItem: Set the URL of the item of data.
setUserId(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.nmpi.Job: Sets the userId.
setUserScript(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Sets the user script.
setVersion(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the version of the machine.
setWidth(int) - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Sets the width of the machine in chips.
setWorkingDirectory(String) - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.pynn.PyNNJobParameters: Sets the workingDirectory.
SpinnakerMachine - Class in uk.ac.manchester.spinnaker.nmpi.model.machine: Represents a SpiNNaker machine on which jobs can be executed.
SpinnakerMachine() - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Creates an empty machine.
SpinnakerMachine(String, String, int, int, int, String) - Constructor for class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Creates a new SpiNNaker Machine description.
Status - Enum in uk.ac.manchester.spinnaker.nmpi.model.job: The possible statuses of a process.

T

TEXT_PLAIN - Static variable in interface uk.ac.manchester.spinnaker.nmpi.model.job.JobManagerInterface: The media type for text.
toSTE() - Method in class uk.ac.manchester.spinnaker.nmpi.model.job.RemoteStackTraceElement: Convert this remote stack trace element to a standard Java stack trace element.
toString() - Method in class uk.ac.manchester.spinnaker.nmpi.model.machine.SpinnakerMachine: Get a string version of the machine.

U

uk.ac.manchester.spinnaker.nmpi.model.job - package uk.ac.manchester.spinnaker.nmpi.model.job: The description of SpiNNaker jobs.
uk.ac.manchester.spinnaker.nmpi.model.job.nmpi - package uk.ac.manchester.spinnaker.nmpi.model.job.nmpi: The description of SpiNNaker jobs based on the HBP NMPI.
uk.ac.manchester.spinnaker.nmpi.model.job.pynn - package uk.ac.manchester.spinnaker.nmpi.model.job.pynn: The description of parameters for SpiNNaker jobs that use PyNN.
uk.ac.manchester.spinnaker.nmpi.model.machine - package uk.ac.manchester.spinnaker.nmpi.model.machine: The description of SpiNNaker machines.

V

value() - Method in annotation type uk.ac.manchester.spinnaker.nmpi.model.job.JobParametersTypeName: The type name.
valueOf(String) - Static method in enum uk.ac.manchester.spinnaker.nmpi.model.job.Status: Returns the enum constant of this type with the specified name.
values() - Static method in enum uk.ac.manchester.spinnaker.nmpi.model.job.Status: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I J P R S T U V
All Classes|All Packages