Interface SpallocAPI.SubMachine
- Enclosing interface:
- SpallocAPI
public static interface SpallocAPI.SubMachine
A view of part of a machine that is allocated to a job.
-
Method Summary
Modifier and Type Method Description List<BoardCoordinates>
getBoards()
List<ConnectionInfo>
getConnections()
int
getDepth()
int
getHeight()
SpallocAPI.Machine
getMachine()
PowerState
getPower()
int
getRootX()
int
getRootY()
int
getRootZ()
int
getWidth()
void
setPower(@NotNull PowerState powerState)
Set whether this sub-machine is switched on.
-
Method Details
-
getMachine
SpallocAPI.Machine getMachine()- Returns:
- The machine that this sub-machine is part of.
-
getRootX
int getRootX()- Returns:
- The root X coordinate of this sub-machine.
-
getRootY
int getRootY()- Returns:
- The root Y coordinate of this sub-machine.
-
getRootZ
int getRootZ()- Returns:
- The root Z coordinate of this sub-machine.
-
getWidth
int getWidth()- Returns:
- The width of this sub-machine, in triads.
-
getHeight
int getHeight()- Returns:
- The height of this sub-machine, in triads.
-
getDepth
int getDepth()- Returns:
- The depth of this sub-machine. 1 (single board) or 3 (by triad)
-
getConnections
List<ConnectionInfo> getConnections()- Returns:
- The connection details of this sub-machine.
-
getBoards
List<BoardCoordinates> getBoards()- Returns:
- The board locations of this sub-machine.
-
getPower
PowerState getPower()- Returns:
- Whether this sub-machine is switched on.
-
setPower
Set whether this sub-machine is switched on. Note that actually changing the power of a sub-machine can take some time.- Parameters:
powerState
- What to set the power state to.
-