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

Enum Class Signal

java.lang.Object
java.lang.Enum<Signal>
uk.ac.manchester.spinnaker.messages.model.Signal
All Implemented Interfaces:
Serializable, Comparable<Signal>, Constable
public enum Signal extends Enum<Signal>
SCP Signals.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Signal.Type
    The type of signal, determined by how it is transmitted.

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONTINUE
    Tells apps to continue from pause.
    EXIT
    Tells apps to exit.
    INITIALISE
    The system is initialising after boot.
    PAUSE
    Tells apps to pause.
    POWER_DOWN
    The system is powering down.
    START
    Tells apps to start.
    STOP
    The system is ceasing to run user apps.
    SYNC0
    Tells apps to advance from the SYNC0 state.
    SYNC1
    Tells apps to advance from the SYNC1 state.
    TIMER
    Used for clock synchronisation?
    USER_0
    For application use.
    USER_1
    For application use.
    USER_2
    For application use.
    USER_3
    For application use.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final Signal.Type
    type
    The "type" of the signal.
    final byte
    value
    The value used for the signal.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Signal
    get(byte value)
    Convert a byte to a signal value.
    static Signal
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Signal[]
    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

    • INITIALISE

      public static final Signal INITIALISE
      The system is initialising after boot.

    • POWER_DOWN

      public static final Signal POWER_DOWN
      The system is powering down.

    • STOP

      public static final Signal STOP
      The system is ceasing to run user apps.

    • START

      public static final Signal START
      Tells apps to start.

    • SYNC0

      public static final Signal SYNC0
      Tells apps to advance from the SYNC0 state.

    • SYNC1

      public static final Signal SYNC1
      Tells apps to advance from the SYNC1 state.

    • PAUSE

      public static final Signal PAUSE
      Tells apps to pause.

    • CONTINUE

      public static final Signal CONTINUE
      Tells apps to continue from pause.

    • EXIT

      public static final Signal EXIT
      Tells apps to exit.

    • TIMER

      public static final Signal TIMER
      Used for clock synchronisation?

    • USER_0

      public static final Signal USER_0
      For application use.

    • USER_1

      public static final Signal USER_1
      For application use.

    • USER_2

      public static final Signal USER_2
      For application use.

    • USER_3

      public static final Signal USER_3
      For application use.

  • Field Details

    • value

      public final byte value
      The value used for the signal.

    • type

      public final Signal.Type type
      The "type" of the signal.

  • Method Details

    • values

      public static Signal[] 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 Signal 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

    • get

      public static Signal get(byte value)
      Convert a byte to a signal value.
      Parameters:
      value - The value to decode.
      Returns:
      The decoded value.
      Throws:
      NullPointerException - If the value is unknown.