org.hps.record.scalers

Enum ScalerDataIndex

java.lang.Object

java.lang.Enum<ScalerDataIndex>

org.hps.record.scalers.ScalerDataIndex

All Implemented Interfaces:

Serializable, Comparable<ScalerDataIndex>

public enum ScalerDataIndex
extends Enum<ScalerDataIndex>

Represents an index into a ScalerData array from EVIO data (full 72 word integer array).

Author:

Jeremy McCormick, SLAC

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOCK_GATED Gated clock.
CLOCK_UNGATED Ungated clock.
FCUP_TDC_GATED Gated Faraday cup TDC threshold.
FCUP_TDC_UNGATED Ungated Faraday cup TDC threshold.
FCUP_TRG_GATED Gated Faraday cup TRG threshold.
FCUP_TRG_UNGATED Ungated Faraday cup TRG threshold.

Field Summary

Fields

Modifier and Type	Field and Description
private int	index The index value within the scaler data array.

Method Summary

Modifier and Type	Method and Description
int	index() Get the index value.
static ScalerDataIndex	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScalerDataIndex[]	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

CLOCK_GATED

public static final ScalerDataIndex CLOCK_GATED

Gated clock.

CLOCK_UNGATED

public static final ScalerDataIndex CLOCK_UNGATED

Ungated clock.

FCUP_TDC_GATED

public static final ScalerDataIndex FCUP_TDC_GATED

Gated Faraday cup TDC threshold.

FCUP_TDC_UNGATED

public static final ScalerDataIndex FCUP_TDC_UNGATED

Ungated Faraday cup TDC threshold.

FCUP_TRG_GATED

public static final ScalerDataIndex FCUP_TRG_GATED

Gated Faraday cup TRG threshold.

FCUP_TRG_UNGATED

public static final ScalerDataIndex FCUP_TRG_UNGATED

Ungated Faraday cup TRG threshold.

Field Detail

index

private int index

The index value within the scaler data array.

Method Detail

values

public static ScalerDataIndex[] 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 (ScalerDataIndex c : ScalerDataIndex.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScalerDataIndex valueOf(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:

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

NullPointerException - if the argument is null

index

public int index()

Get the index value.

Returns:

the index value