Package org.eclipse.scanning.api.event.scan

Enum Class DeviceState

java.lang.Object
java.lang.Enum<DeviceState>
org.eclipse.scanning.api.event.scan.DeviceState
All Implemented Interfaces:
Serializable, Comparable<DeviceState>, Constable
public enum DeviceState extends Enum<DeviceState>
The state that the scanning system device may be in, for instance a MalcolmDevice.

  • Enum Constant Details

  • Method Details

    • values

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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<DeviceState>

    • isRunnable

      public boolean isRunnable()
      The run method may be called
      Returns:

    • isRunning

      public boolean isRunning()

    • isBeforeRun

      public boolean isBeforeRun()
      Before run means that the state is before running and not in error.
      Returns:

    • isRest

      public boolean isRest()

    • isAbortable

      public boolean isAbortable()

    • isResetable

      public boolean isResetable()

    • isTransient

      public boolean isTransient()

    • isRestState

      public boolean isRestState()