Package uk.ac.manchester.spinnaker.messages.model

Class BMPConnectionData

java.lang.Object

uk.ac.manchester.spinnaker.messages.model.BMPConnectionData

public class BMPConnectionData
extends Object

Contains the details of a connection to a SpiNNaker Board Management Processor (BMP).

Field Summary

Fields

Modifier and Type	Field	Description
final @Valid BMPCoords	bmp	The coordinates of the BMP that manages a set of boards.
final Collection<@Valid BMPBoard>	boards	The boards to be addressed.
final @IPAddress InetAddress	ipAddress	The IP address of the BMP.
final @UDPPort Integer	portNumber	The port number associated with the BMP connection, or null for the default.

Constructor Summary

Constructors

Constructor	Description
BMPConnectionData(int cabinet, int frame, InetAddress ipAddress, Collection<Integer> boards, Integer portNumber)
BMPConnectionData(InetAddress host, int numBoards)	Work out the BMP connection IP address given the machine details.
BMPConnectionData(BMPCoords coords, InetAddress ipAddress, Collection<Integer> boards, Integer portNumber)

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

boards

public final Collection<@Valid BMPBoard> boards

The boards to be addressed. Unmodifiable.

bmp

@Valid
public final @Valid BMPCoords bmp

The coordinates of the BMP that manages a set of boards.

ipAddress

@IPAddress
public final @IPAddress InetAddress ipAddress

The IP address of the BMP.

portNumber

@UDPPort
public final @UDPPort Integer portNumber

The port number associated with the BMP connection, or null for the default.

Constructor Details

BMPConnectionData

public BMPConnectionData(int cabinet,
 int frame,
 InetAddress ipAddress,
 Collection<Integer> boards,
 Integer portNumber)

Parameters:

cabinet - The number of the cabinet containing the frame.

frame - The number of the frame containing the boards.

ipAddress - The address of the BMP.

boards - The boards controlled by the BMP.

portNumber - The BMP's port.

BMPConnectionData

public BMPConnectionData(BMPCoords coords,
 InetAddress ipAddress,
 Collection<Integer> boards,
 Integer portNumber)

Parameters:

coords - The coordinates of the BMP.

ipAddress - The address of the BMP.

boards - The boards controlled by the BMP.

portNumber - The BMP's port.

BMPConnectionData

public BMPConnectionData(InetAddress host,
 int numBoards)
                  throws UnknownHostException

Work out the BMP connection IP address given the machine details. This is assumed to be the IP address of the machine, with 1 subtracted from the final part e.g. if the machine IP address is 192.168.0.5, the BMP IP address is assumed to be 192.168.0.4.

This algorithm is rather hokey. Far better for the user to simply know where the BMP actually is (this is necessary in any large deployment anyway).

Parameters:

host - the SpiNNaker machine main host

numBoards - the number of boards in the machine

Throws:

UnknownHostException - If the IP address computations fail

IllegalArgumentException - If a host with an address that can't be related to a BMP is given. Specifically, the given IP address can't end in .0 or .1 or things will not work.

Method Details

toString

public String toString()

Overrides:

toString in class Object