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

Enum Class DeviceRole

java.lang.Object

java.lang.Enum<DeviceRole>

org.eclipse.scanning.api.device.models.DeviceRole

All Implemented Interfaces:

Serializable, Comparable<DeviceRole>, Constable

public enum DeviceRole
extends Enum<DeviceRole>

Each runnable device has a role to be used when building UI or constucting scans or for validation. For instance and when the user interface provides drop downs of devices it will inspect role to see if a given device is applicable.

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	The device is either backed by a GDA hardware connection through EPICS or DAServer or is an in memory device which should be treated like a hardware one, for instance the MandelbrotDetector.
MALCOLM	The device is backed by a malcolm connection
PROCESSING	This device is for processing the values of other devices.
VIRTUAL	For instance in memory devices which are always created new, like the AcquisitionDevice Virtual devices can never be created

Method Summary

Modifier and Type	Method	Description
boolean	isDetector()
boolean	isMalcolm()
boolean	isProcessing()
boolean	isVirtual()
static DeviceRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DeviceRole[]	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

VIRTUAL

public static final DeviceRole VIRTUAL

For instance in memory devices which are always created new, like the AcquisitionDevice Virtual devices can never be created

MALCOLM

public static final DeviceRole MALCOLM

The device is backed by a malcolm connection

HARDWARE

public static final DeviceRole HARDWARE

The device is either backed by a GDA hardware connection through EPICS or DAServer or is an in memory device which should be treated like a hardware one, for instance the MandelbrotDetector. The device writes its data at each point in the GDA software scan

PROCESSING

public static final DeviceRole PROCESSING

This device is for processing the values of other devices. For instance the same class could have multiple instances with different models to do different processing.

Method Details

values

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

isVirtual

public boolean isVirtual()

isMalcolm

public boolean isMalcolm()

isDetector

public boolean isDetector()

isProcessing

public boolean isProcessing()