Package xal.smf.impl.profile

Enum Class Signal.FIELD

java.lang.Object

java.lang.Enum<Signal.FIELD>

xal.smf.impl.profile.Signal.FIELD

All Implemented Interfaces:

Serializable, Comparable<Signal.FIELD>, Constable

Enclosing class:

Signal

public static enum Signal.FIELD
extends Enum<Signal.FIELD>

Field names of the Signal class. These are needed for construction of PV field descriptors for the classes aggregating Signal and the ASignalSet.ASet annotation which identifies them.

Since:

Feb 4, 2013

Author:

Christopher K. Allen

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
CNT	This is the enumeration constant for the Signal.cnt field.
NAVG	This is the enumeration constant for the Signal.navg field.
NVAR	This is the enumeration constant for the Signal.nvar field.
POS	This is the enumeration constant for the Signal.pos field.
VAL	This is the enumeration constant for the Signal.val field.

Method Summary

Modifier and Type	Method	Description
ScadaFieldDescriptor	createDescriptor(ASignal annSig)	Creates a new SCADA (PV) field descriptor for the signal field represented by this enumeration constant.
static Signal.FIELD	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Signal.FIELD[]	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

CNT

public static final Signal.FIELD CNT

This is the enumeration constant for the Signal.cnt field.

POS

public static final Signal.FIELD POS

This is the enumeration constant for the Signal.pos field.

VAL

public static final Signal.FIELD VAL

This is the enumeration constant for the Signal.val field.

NAVG

public static final Signal.FIELD NAVG

This is the enumeration constant for the Signal.navg field.

NVAR

public static final Signal.FIELD NVAR

This is the enumeration constant for the Signal.nvar field.

Method Details

values

public static Signal.FIELD[] 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 Signal.FIELD 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

createDescriptor

public ScadaFieldDescriptor createDescriptor(ASignal annSig)
                                      throws ScadaAnnotationException

Creates a new SCADA (PV) field descriptor for the signal field represented by this enumeration constant. The data to create the field descriptor is taken from the provided annotation.

NOTE:

· If the annotation field corresponding to this enumeration is set to the empty string "", the method will return a null value. Since it is not necessary for all handles to be specified this is not necessarily a failure condition.

Parameters:

annSig - the annotation from which we are extracting the parameters

Returns:

A new SCADA field descriptor for the the field of this enumeration (from given signal annotation), or null if the given annotation does not contain the PV signal names

Throws:

ScadaAnnotationException - general error with argument annSig, ill defined

Since:

Feb 6, 2013