xal.smf.impl.profile

Enum ProfileDevice.ANGLE

java.lang.Object

java.lang.Enum<ProfileDevice.ANGLE>

xal.smf.impl.profile.ProfileDevice.ANGLE

All Implemented Interfaces:

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

Enclosing class:

ProfileDevice

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

Enumeration of the projection angles used to produce the profile data.

Since:

Jul 16, 2009

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIA the diagonal plane
HOR the horizontal plane
VER the vertical plane

Method Summary

Modifier and Type	Method and Description
int	getIndex() The the array index for this plot enumeration constant.
java.lang.String	getLabel() Returns the plot label for this enumeration constant.
SignalAttrs	getSignalAttrs(SignalAttrSet setAttrs) Extracts the proper signal attributes w.r.t.
ScadaFieldDescriptor	getSignalPosFd(java.lang.Class<? extends SignalSet> clsData) Extracts the field descriptor for the position channel from the annotations of the given SignalSet-derived class type.
ScadaFieldDescriptor	getSignalValFd(java.lang.Class<? extends SignalSet> clsData) Extracts the field descriptor for the signal value channel from the set of acquisition descriptors.
static ProfileDevice.ANGLE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProfileDevice.ANGLE[]	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

HOR

public static final ProfileDevice.ANGLE HOR

the horizontal plane

VER

public static final ProfileDevice.ANGLE VER

the vertical plane

DIA

public static final ProfileDevice.ANGLE DIA

the diagonal plane

Method Detail

values

public static ProfileDevice.ANGLE[] 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.ANGLE c : ProfileDevice.ANGLE.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.ANGLE 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

getIndex

public int getIndex()

The the array index for this plot enumeration constant.

Returns:

plot array index

Since:

Jul 16, 2009

getLabel

public java.lang.String getLabel()

Returns the plot label for this enumeration constant.

Returns:

plot label

Since:

Jul 16, 2009

getSignalAttrs

public SignalAttrs getSignalAttrs(SignalAttrSet setAttrs)

Extracts the proper signal attributes w.r.t. to this plane from the given set of signal attributes.

Parameters:

setAttrs - set of signal attributes, one for each phase plane

Returns:

signal attributes corresponding to this phase plane

Since:

Mar 26, 2014

getSignalPosFd

public ScadaFieldDescriptor getSignalPosFd(java.lang.Class<? extends SignalSet> clsData)
                                    throws ScadaAnnotationException

Extracts the field descriptor for the position channel from the annotations of the given SignalSet-derived class type.

Parameters:

clsData - the Data-derived child class with DAQ annotations

Returns:

position channel field descriptor for this plane

Throws:

ScadaAnnotationException - a required field of the ASet annotation was empty or annotation not found

Since:

Sep 27, 2011

getSignalValFd

public ScadaFieldDescriptor getSignalValFd(java.lang.Class<? extends SignalSet> clsData)
                                    throws ScadaAnnotationException

Extracts the field descriptor for the signal value channel from the set of acquisition descriptors.

Parameters:

clsData - the SignalSet-derived child class with DAQ annotations

Returns:

signal value channel field descriptor for this plane

Throws:

ScadaAnnotationException - a required field of the ASet annotation was empty or annotation not found

Since:

Feb 22, 2011