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

Enum MadxDynapVariable

java.lang.Object

java.lang.Enum<MadxDynapVariable>

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

All Implemented Interfaces:

DynapVariable, MadxVariable, Variable, java.io.Serializable, java.lang.Comparable<MadxDynapVariable>

public enum MadxDynapVariable
extends java.lang.Enum<MadxDynapVariable>
implements DynapVariable

Enum Constant Summary

Enum Constants

Enum Constant	Description
DKTRTURNS
DTUNE
DYNAPFRAC
PXEND
PYEND
SMEAR
TEND
TUNX
TUNY
UNKNOWN
WXMAX
WXMIN
WXYMAX
WXYMIN
WYMAX
WYMIN
X
XEND
Y
YAPUNOV
YEND

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 MadxDynapVariable	getVariableFromName(java.lang.String name)
MadxVarType	getVarType()
static MadxDynapVariable	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MadxDynapVariable[]	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

DYNAPFRAC

public static final MadxDynapVariable DYNAPFRAC

DKTRTURNS

public static final MadxDynapVariable DKTRTURNS

XEND

public static final MadxDynapVariable XEND

PXEND

public static final MadxDynapVariable PXEND

YEND

public static final MadxDynapVariable YEND

PYEND

public static final MadxDynapVariable PYEND

TEND

public static final MadxDynapVariable TEND

WXMIN

public static final MadxDynapVariable WXMIN

WXMAX

public static final MadxDynapVariable WXMAX

WYMIN

public static final MadxDynapVariable WYMIN

WYMAX

public static final MadxDynapVariable WYMAX

WXYMIN

public static final MadxDynapVariable WXYMIN

WXYMAX

public static final MadxDynapVariable WXYMAX

SMEAR

public static final MadxDynapVariable SMEAR

YAPUNOV

public static final MadxDynapVariable YAPUNOV

X

public static final MadxDynapVariable X

Y

public static final MadxDynapVariable Y

TUNX

public static final MadxDynapVariable TUNX

TUNY

public static final MadxDynapVariable TUNY

DTUNE

public static final MadxDynapVariable DTUNE

UNKNOWN

public static final MadxDynapVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

getVariableFromName

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

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