xal.smf.impl.profile

Enum ProfileDevice.GAIN

java.lang.Object

java.lang.Enum<ProfileDevice.GAIN>

xal.smf.impl.profile.ProfileDevice.GAIN

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProfileDevice.GAIN>

Enclosing class:

ProfileDevice

public static enum ProfileDevice.GAIN
extends java.lang.Enum<ProfileDevice.GAIN>

Enumeration of the gain constants for the ProfileDevice amplifier gain values.

Since:

Dec 22, 2009

See Also:

WireScanner.SmplConfig#signalGain, WireHarp.DevConfig#gainCmn

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH High gain circuit
LOW Low gain circuit
MED Medium gain circuit
UNKNOWN Unknown gain value

Method Summary

Modifier and Type	Method and Description
static ProfileDevice.GAIN	getGainFromValue(int intGain) Returns the gain enumeration constant for the given gain value.
int	getGainValue() Return the value of the gain enumeration.
static ProfileDevice.GAIN	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProfileDevice.GAIN[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ProfileDevice.GAIN UNKNOWN

Unknown gain value

LOW

public static final ProfileDevice.GAIN LOW

Low gain circuit

MED

public static final ProfileDevice.GAIN MED

Medium gain circuit

HIGH

public static final ProfileDevice.GAIN HIGH

High gain circuit

Method Detail

values

public static ProfileDevice.GAIN[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProfileDevice.GAIN c : ProfileDevice.GAIN.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProfileDevice.GAIN valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getGainFromValue

public static ProfileDevice.GAIN getGainFromValue(int intGain)

Returns the gain enumeration constant for the given gain value.

Parameters:

intGain - value of the desired gain constant

Returns:

corresponding gain enumeration constant for given value, or UNKNOWN if value has no constant

Since:

Dec 22, 2009

getGainValue

public int getGainValue()

Return the value of the gain enumeration.

Returns:

gain circuit value

Since:

Dec 22, 2009