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

Enum Class FPGARecevingLinkCounters

java.lang.Object

java.lang.Enum<FPGARecevingLinkCounters>

uk.ac.manchester.spinnaker.messages.model.FPGARecevingLinkCounters

All Implemented Interfaces:

Serializable, Comparable<FPGARecevingLinkCounters>, Constable

@SARKStruct("spio")
public enum FPGARecevingLinkCounters
extends Enum<FPGARecevingLinkCounters>

FPGA link receive counters. Counters are always read-only.

Author:

Donal Fellows

See Also:

• Spio documentation

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLTE	Incorrect 2-of-7 flits received on link.
FRME	Framing errors on link.
GLTE	Glitches detected on link.
PRVL	Packets received on link.

Method Summary

Modifier and Type	Method	Description
MemoryLocation	address(int linkNumber)	Get the address of the counter for a particular link.
static FPGARecevingLinkCounters	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FPGARecevingLinkCounters[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRVL

public static final FPGARecevingLinkCounters PRVL

Packets received on link.

FLTE

public static final FPGARecevingLinkCounters FLTE

Incorrect 2-of-7 flits received on link.

FRME

public static final FPGARecevingLinkCounters FRME

Framing errors on link.

GLTE

public static final FPGARecevingLinkCounters GLTE

Glitches detected on link.

Method Details

values

public static FPGARecevingLinkCounters[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FPGARecevingLinkCounters valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

address

public MemoryLocation address(int linkNumber)

Get the address of the counter for a particular link.

Parameters:

linkNumber - The link number. Must be 0, 1, or 2.

Returns:

The address (in FPGA space).

Throws:

IllegalArgumentException - if a bad link number is given.