Enum Class PeripheralInformation.State

java.lang.Object
java.lang.Enum<PeripheralInformation.State>
org.opentcs.data.model.PeripheralInformation.State
All Implemented Interfaces:
Serializable, Comparable<PeripheralInformation.State>, Constable
Enclosing class:
PeripheralInformation

public static enum PeripheralInformation.State extends Enum<PeripheralInformation.State>
The elements of this enumeration describe the various possible states of a peripheral device.
  • Enum Constant Details

    • NO_PERIPHERAL

      public static final PeripheralInformation.State NO_PERIPHERAL
      Indicates that the location the PeripheralInformation belongs to doesn't represent a peripheral device.
    • UNKNOWN

      public static final PeripheralInformation.State UNKNOWN
      The peripheral device's current state is unknown, e.g. because communication with it is currently not possible for some reason.
    • UNAVAILABLE

      public static final PeripheralInformation.State UNAVAILABLE
      The peripheral device's state is known and it's not in an error state, but it is not available for receiving jobs.
    • ERROR

      public static final PeripheralInformation.State ERROR
      There is a problem with the peripheral device.
    • IDLE

      public static final PeripheralInformation.State IDLE
      The peripheral device is currently idle/available for processing jobs.
    • EXECUTING

      public static final PeripheralInformation.State EXECUTING
      The peripheral device is processing a job.
  • Method Details

    • values

      public static PeripheralInformation.State[] 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 PeripheralInformation.State 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