Package uk.ac.manchester.spinnaker.machine.datalinks

Enum FpgaId

java.lang.Object
java.lang.Enum<FpgaId>
uk.ac.manchester.spinnaker.machine.datalinks.FpgaId
All Implemented Interfaces:
Serializable, Comparable<FpgaId>
public enum FpgaId
extends Enum<FpgaId>
The FPGAs that manage inter-board links.
Author:
Christian-B
See Also:
FpgaEnum

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    BOTTOM
    The FGPA link that connects to the bottom and bottom right chips.
    LEFT
    The FGPA link that connects to the left and top left chips.
    TOP_RIGHT
    The FGPA link that connects to the top and right chips.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    int id
    The physical ID for this link.

  • Method Summary

    Modifier and Type Method Description
    static FpgaId byId​(int id)
    Obtain the enum from the ID.
    static FpgaId valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static FpgaId[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BOTTOM

      public static final FpgaId BOTTOM
      The FGPA link that connects to the bottom and bottom right chips.

    • LEFT

      public static final FpgaId LEFT
      The FGPA link that connects to the left and top left chips.

    • TOP_RIGHT

      public static final FpgaId TOP_RIGHT
      The FGPA link that connects to the top and right chips.

  • Field Details

    • id

      public final int id
      The physical ID for this link.

  • Method Details

    • values

      public static FpgaId[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static FpgaId valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • byId

      public static FpgaId byId​(int id) throws ArrayIndexOutOfBoundsException
      Obtain the enum from the ID.
      Parameters:
      id - The physical ID for the FPGA link.
      Returns:
      The ID as an enum
      Throws:
      ArrayIndexOutOfBoundsException - Thrown if the ID is outside the known range.