Package cern.accsoft.steering.jmad.domain.var.enums

Enum MadxTrackVariable

java.lang.Object

java.lang.Enum<MadxTrackVariable>

cern.accsoft.steering.jmad.domain.var.enums.MadxTrackVariable

All Implemented Interfaces:

MadxVariable, TrackVariable, Variable, java.io.Serializable, java.lang.Comparable<MadxTrackVariable>

public enum MadxTrackVariable
extends java.lang.Enum<MadxTrackVariable>
implements TrackVariable

Enum Constant Summary

Enum Constants

Enum Constant	Description
E
NUMBER
PT
PX
PY
S
T
TURN
UNKNOWN
X
Y

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMadxName()	retrieve the name of the variable.
java.lang.String	getName()
java.lang.String	getUnit()
java.lang.Class<?>	getValueClass()	the type of the values which this variable represents
static MadxTrackVariable	getVariableFromName(java.lang.String name)
MadxVarType	getVarType()
static MadxTrackVariable	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MadxTrackVariable[]	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

NUMBER

public static final MadxTrackVariable NUMBER

TURN

public static final MadxTrackVariable TURN

X

public static final MadxTrackVariable X

PX

public static final MadxTrackVariable PX

Y

public static final MadxTrackVariable Y

PY

public static final MadxTrackVariable PY

T

public static final MadxTrackVariable T

PT

public static final MadxTrackVariable PT

S

public static final MadxTrackVariable S

E

public static final MadxTrackVariable E

UNKNOWN

public static final MadxTrackVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static MadxTrackVariable 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

getName

public java.lang.String getName()

Specified by:

getName in interface Variable

Returns:

the name of the variable (can be arbitrary)

getUnit

public java.lang.String getUnit()

Specified by:

getUnit in interface Variable

Returns:

a string, that represents the unit of the variable

getValueClass

public java.lang.Class<?> getValueClass()

Description copied from interface: Variable

the type of the values which this variable represents

Specified by:

getValueClass in interface Variable

Returns:

The class of the values

getMadxName

public java.lang.String getMadxName()

Description copied from interface: MadxVariable

retrieve the name of the variable. This must be a unique expression within the madx model.

Specified by:

getMadxName in interface MadxVariable

Returns:

the name of the variable.

getVarType

public MadxVarType getVarType()

Specified by:

getVarType in interface MadxVariable

Returns:

the type (String/Double) of the variable

getVariableFromName

public static MadxTrackVariable getVariableFromName(java.lang.String name)