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

Enum MadxTwissVariable

java.lang.Object

java.lang.Enum<MadxTwissVariable>

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

All Implemented Interfaces:

MadxVariable, TwissVariable, Variable, java.io.Serializable, java.lang.Comparable<MadxTwissVariable>

public enum MadxTwissVariable
extends java.lang.Enum<MadxTwissVariable>
implements TwissVariable

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALFX
ALFY
ANGLE
BETX
BETY
DBX
DBY
DDPX
DDPY
DDX
DDY
DELTAP
DMUX
DMUY
DPX
DPY
DX
DY
GAMX
GAMY
HKICK
K0L
K0SL
K1L
K1SL
K2L
K2SL
K3L
K3SL
K4L
K4SL
K5L
KEYWORD
L
MUX
MUY
NAME
PARENT
PHIT
PHIX
PHIY
POLARITY
PT
PTN
PX
PXN
PY
PYN
R11
R12
R21
R22
S
SIGX
SIGY
T
TN
UNKNOWN
VKICK
WT
WX
WY
X
XN
Y
YN

Method Summary

Modifier and Type	Method	Description
static java.util.Set<MadxTwissVariable>	allOfType(MadxVarType type)	returns a set of variables of a given type.
static MadxTwissVariable	fromMadxName(java.lang.String madxName)	Determine the correct Value of Variable for a given tag.
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
MadxVarType	getVarType()
boolean	isApertureVariable()
java.lang.String	toString()
static MadxTwissVariable	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MadxTwissVariable[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final MadxTwissVariable NAME

KEYWORD

public static final MadxTwissVariable KEYWORD

PARENT

public static final MadxTwissVariable PARENT

X

public static final MadxTwissVariable X

PX

public static final MadxTwissVariable PX

Y

public static final MadxTwissVariable Y

PY

public static final MadxTwissVariable PY

T

public static final MadxTwissVariable T

PT

public static final MadxTwissVariable PT

DELTAP

public static final MadxTwissVariable DELTAP

S

public static final MadxTwissVariable S

L

public static final MadxTwissVariable L

XN

public static final MadxTwissVariable XN

PXN

public static final MadxTwissVariable PXN

WX

public static final MadxTwissVariable WX

PHIX

public static final MadxTwissVariable PHIX

YN

public static final MadxTwissVariable YN

PYN

public static final MadxTwissVariable PYN

WY

public static final MadxTwissVariable WY

PHIY

public static final MadxTwissVariable PHIY

TN

public static final MadxTwissVariable TN

PTN

public static final MadxTwissVariable PTN

WT

public static final MadxTwissVariable WT

PHIT

public static final MadxTwissVariable PHIT

BETX

public static final MadxTwissVariable BETX

ALFX

public static final MadxTwissVariable ALFX

MUX

public static final MadxTwissVariable MUX

DX

public static final MadxTwissVariable DX

DPX

public static final MadxTwissVariable DPX

BETY

public static final MadxTwissVariable BETY

ALFY

public static final MadxTwissVariable ALFY

MUY

public static final MadxTwissVariable MUY

DY

public static final MadxTwissVariable DY

DPY

public static final MadxTwissVariable DPY

GAMX

public static final MadxTwissVariable GAMX

GAMY

public static final MadxTwissVariable GAMY

SIGX

public static final MadxTwissVariable SIGX

SIGY

public static final MadxTwissVariable SIGY

DMUX

public static final MadxTwissVariable DMUX

DDX

public static final MadxTwissVariable DDX

DDPX

public static final MadxTwissVariable DDPX

DMUY

public static final MadxTwissVariable DMUY

DDY

public static final MadxTwissVariable DDY

DDPY

public static final MadxTwissVariable DDPY

DBX

public static final MadxTwissVariable DBX

DBY

public static final MadxTwissVariable DBY

K0L

public static final MadxTwissVariable K0L

K1L

public static final MadxTwissVariable K1L

K2L

public static final MadxTwissVariable K2L

K3L

public static final MadxTwissVariable K3L

K4L

public static final MadxTwissVariable K4L

K5L

public static final MadxTwissVariable K5L

K0SL

public static final MadxTwissVariable K0SL

K1SL

public static final MadxTwissVariable K1SL

K2SL

public static final MadxTwissVariable K2SL

K3SL

public static final MadxTwissVariable K3SL

K4SL

public static final MadxTwissVariable K4SL

ANGLE

public static final MadxTwissVariable ANGLE

HKICK

public static final MadxTwissVariable HKICK

VKICK

public static final MadxTwissVariable VKICK

POLARITY

public static final MadxTwissVariable POLARITY

R11

public static final MadxTwissVariable R11

R12

public static final MadxTwissVariable R12

R21

public static final MadxTwissVariable R21

R22

public static final MadxTwissVariable R22

UNKNOWN

public static final MadxTwissVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

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

fromMadxName

public static final MadxTwissVariable fromMadxName(java.lang.String madxName)

Determine the correct Value of Variable for a given tag.

Parameters:

madxName - the tag for which to get the VarType - Value.

Returns:

The VarType corresponding to the given tag.

allOfType

public static final java.util.Set<MadxTwissVariable> allOfType(MadxVarType type)

returns a set of variables of a given type.

Parameters:

type - which variables to retrieve

Returns:

the variables.

isApertureVariable

public boolean isApertureVariable()

Specified by:

isApertureVariable in interface TwissVariable

Returns:

true, if this variable shall be plotted as aperture (second line with minus-sign)

getUnit

public java.lang.String getUnit()

Specified by:

getUnit in interface Variable

Returns:

a string, that represents the unit of the variable

getName

public java.lang.String getName()

Specified by:

getName in interface Variable

Returns:

the name of the variable (can be arbitrary)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<MadxTwissVariable>

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