Package uk.ac.manchester.spinnaker.machine

Class RegionLocation

java.lang.Object

uk.ac.manchester.spinnaker.machine.RegionLocation

All Implemented Interfaces:

Comparable<RegionLocation>, HasChipLocation, HasCoreLocation

@Immutable
public final class RegionLocation
extends Object
implements HasCoreLocation, Comparable<RegionLocation>

Holding case for a CoreLocation (X, Y and P) and the recording region ID.

Author:

Christian-B

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<RegionLocation>	COMPARATOR	Comparator for region locations.
final @uk.ac.manchester.spinnaker.machine.ValidP int	p	The Core's P value.
final int	region	The recording region ID.
final @uk.ac.manchester.spinnaker.machine.ValidX int	x	The Chip / Core's X value.
final @uk.ac.manchester.spinnaker.machine.ValidY int	y	The Chip / Core's Y value.

Constructor Summary

Constructors

Constructor	Description
RegionLocation(HasCoreLocation core, int region)	Creates the region based on a core and a region.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RegionLocation o)
boolean	equals(Object obj)
int	getP()
int	getX()
int	getY()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.manchester.spinnaker.machine.HasChipLocation

asChipLocation, getScampCore, onSameChipAs

Methods inherited from interface uk.ac.manchester.spinnaker.machine.HasCoreLocation

asCoreLocation, onSameCoreAs

Field Details

x

@ValidX
public final @uk.ac.manchester.spinnaker.machine.ValidX int x

The Chip / Core's X value.

y

@ValidY
public final @uk.ac.manchester.spinnaker.machine.ValidY int y

The Chip / Core's Y value.

p

@ValidP
public final @uk.ac.manchester.spinnaker.machine.ValidP int p

The Core's P value.

region

public final int region

The recording region ID.

COMPARATOR

public static final Comparator<RegionLocation> COMPARATOR

Comparator for region locations.

Constructor Details

RegionLocation

public RegionLocation(HasCoreLocation core,
 int region)

Creates the region based on a core and a region.

Parameters:

core - The core to use

region - The ID of the region to use.

Method Details

getP

public int getP()

Specified by:

getP in interface HasCoreLocation

Returns:

The processor coordinate of the core on its chip.

getX

public int getX()

Specified by:

getX in interface HasChipLocation

Returns:

The X coordinate of the chip.

getY

public int getY()

Specified by:

getY in interface HasChipLocation

Returns:

The Y coordinate of the chip.

compareTo

public int compareTo(RegionLocation o)

Specified by:

compareTo in interface Comparable<RegionLocation>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object