Package eu.ess.bled.devices.lattice

Enum Class MultipoleMagnet.MagnetType

java.lang.Object

java.lang.Enum<MultipoleMagnet.MagnetType>

eu.ess.bled.devices.lattice.MultipoleMagnet.MagnetType

All Implemented Interfaces:

Serializable, Comparable<MultipoleMagnet.MagnetType>, Constable

Enclosing class:

MultipoleMagnet

public static enum MultipoleMagnet.MagnetType
extends Enum<MultipoleMagnet.MagnetType>

MagnetType describes different types of multipoles.

Author:

Jaka Bobnar

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
DECAPOLE
DIPOLE
DODECAPOLE
OCTUPOLE
QUADRUPOLE
SEXTUPOLE
SOLENOID

Method Summary

Modifier and Type	Method	Description
int	getIntegerValue()	Returns the integer representation of this type.
static MultipoleMagnet.MagnetType	toEnum(int val)	Returns the type that corresponds to the given int value.
static MultipoleMagnet.MagnetType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MultipoleMagnet.MagnetType[]	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

SOLENOID

public static final MultipoleMagnet.MagnetType SOLENOID

DIPOLE

public static final MultipoleMagnet.MagnetType DIPOLE

QUADRUPOLE

public static final MultipoleMagnet.MagnetType QUADRUPOLE

SEXTUPOLE

public static final MultipoleMagnet.MagnetType SEXTUPOLE

OCTUPOLE

public static final MultipoleMagnet.MagnetType OCTUPOLE

DECAPOLE

public static final MultipoleMagnet.MagnetType DECAPOLE

DODECAPOLE

public static final MultipoleMagnet.MagnetType DODECAPOLE

Method Details

values

public static MultipoleMagnet.MagnetType[] 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 MultipoleMagnet.MagnetType 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

toEnum

public static MultipoleMagnet.MagnetType toEnum(int val)

Returns the type that corresponds to the given int value.

Parameters:

val - the requested value

Returns:

the enum type

getIntegerValue

public int getIntegerValue()

Returns the integer representation of this type.

Returns:

the integer value