Package org.eclipse.scanning.api.device.models

Enum Class ScanMode

java.lang.Object

java.lang.Enum<ScanMode>

org.eclipse.scanning.api.device.models.ScanMode

All Implemented Interfaces:

Serializable, Comparable<ScanMode>, Constable

public enum ScanMode
extends Enum<ScanMode>

An enumeration of detector modes. This determines whether the detector can take part in a GDA scan or a hardare (i.e. malcolm) scan. A detector may support one or both of these modes.

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
HARDWARE	A scan that is at least partially (an inner-scan) performed by hardware (i.e.
SOFTWARE	A scan that is run entirely in software by GDA

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns a user friendly name, e.g.
static ScanMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScanMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SOFTWARE

public static final ScanMode SOFTWARE

A scan that is run entirely in software by GDA

HARDWARE

public static final ScanMode HARDWARE

A scan that is at least partially (an inner-scan) performed by hardware (i.e. malcolm) with GDA only performing an outer scan.

Method Details

values

public static ScanMode[] 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 ScanMode 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()

Returns a user friendly name, e.g. SOFTWARE -> "Software"

Overrides:

toString in class Enum<ScanMode>

See Also:

• Enum.toString()