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

Enum PtcGlobalVariable

java.lang.Object

java.lang.Enum<PtcGlobalVariable>

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

All Implemented Interfaces:

GlobalVariable, MadxVariable, Variable, java.io.Serializable, java.lang.Comparable<PtcGlobalVariable>

public enum PtcGlobalVariable
extends java.lang.Enum<PtcGlobalVariable>
implements GlobalVariable

This enum represents madx global variables, which appear in general in the sum-table of the twiss. TODO define units

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHA_C
ALPHA_C_P
ALPHA_C_P2
ALPHA_C_P3
BCURRENT
BETA_X_MAX
BETA_X_MIN
BETA_Y_MAX
BETA_Y_MIN
CHARGE
DATE
DELTAP
DQ1
DQ2
ENERGY
ET
ETA_C
EX
EY
GAMMA
GAMMA_TR
KBUNCH
LENGTH
MASS
NAME
NPART
ORBIT_CT
ORBIT_PT
ORBIT_PX
ORBIT_PY
ORBIT_X
ORBIT_Y
ORIGIN
PARTICLE
PC
PXCOMAX
PXCORMS
PYCOMAX
PYCORMS
Q1
Q2
QS
SEQUENCE
SIGE
SIGT
TIME
TITLE
TYPE
UNKNOWN
XCOMAX
XCORMS
YCOMAX
YCORMS

Method Summary

Modifier and Type	Method	Description
static java.util.Set<PtcGlobalVariable>	allOfType(MadxVarType varType)
static PtcGlobalVariable	fromMadxName(java.lang.String madxName)
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()
java.lang.String	toString()
static PtcGlobalVariable	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PtcGlobalVariable[]	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 PtcGlobalVariable NAME

TYPE

public static final PtcGlobalVariable TYPE

SEQUENCE

public static final PtcGlobalVariable SEQUENCE

PARTICLE

public static final PtcGlobalVariable PARTICLE

MASS

public static final PtcGlobalVariable MASS

CHARGE

public static final PtcGlobalVariable CHARGE

ENERGY

public static final PtcGlobalVariable ENERGY

PC

public static final PtcGlobalVariable PC

GAMMA

public static final PtcGlobalVariable GAMMA

KBUNCH

public static final PtcGlobalVariable KBUNCH

BCURRENT

public static final PtcGlobalVariable BCURRENT

SIGE

public static final PtcGlobalVariable SIGE

SIGT

public static final PtcGlobalVariable SIGT

NPART

public static final PtcGlobalVariable NPART

EX

public static final PtcGlobalVariable EX

EY

public static final PtcGlobalVariable EY

ET

public static final PtcGlobalVariable ET

LENGTH

public static final PtcGlobalVariable LENGTH

DELTAP

public static final PtcGlobalVariable DELTAP

ALPHA_C

public static final PtcGlobalVariable ALPHA_C

ALPHA_C_P

public static final PtcGlobalVariable ALPHA_C_P

ALPHA_C_P2

public static final PtcGlobalVariable ALPHA_C_P2

ALPHA_C_P3

public static final PtcGlobalVariable ALPHA_C_P3

ETA_C

public static final PtcGlobalVariable ETA_C

GAMMA_TR

public static final PtcGlobalVariable GAMMA_TR

Q1

public static final PtcGlobalVariable Q1

Q2

public static final PtcGlobalVariable Q2

DQ1

public static final PtcGlobalVariable DQ1

DQ2

public static final PtcGlobalVariable DQ2

QS

public static final PtcGlobalVariable QS

BETA_X_MIN

public static final PtcGlobalVariable BETA_X_MIN

BETA_X_MAX

public static final PtcGlobalVariable BETA_X_MAX

BETA_Y_MIN

public static final PtcGlobalVariable BETA_Y_MIN

BETA_Y_MAX

public static final PtcGlobalVariable BETA_Y_MAX

ORBIT_X

public static final PtcGlobalVariable ORBIT_X

ORBIT_PX

public static final PtcGlobalVariable ORBIT_PX

ORBIT_Y

public static final PtcGlobalVariable ORBIT_Y

ORBIT_PY

public static final PtcGlobalVariable ORBIT_PY

ORBIT_PT

public static final PtcGlobalVariable ORBIT_PT

ORBIT_CT

public static final PtcGlobalVariable ORBIT_CT

XCORMS

public static final PtcGlobalVariable XCORMS

PXCORMS

public static final PtcGlobalVariable PXCORMS

YCORMS

public static final PtcGlobalVariable YCORMS

PYCORMS

public static final PtcGlobalVariable PYCORMS

XCOMAX

public static final PtcGlobalVariable XCOMAX

PXCOMAX

public static final PtcGlobalVariable PXCOMAX

YCOMAX

public static final PtcGlobalVariable YCOMAX

PYCOMAX

public static final PtcGlobalVariable PYCOMAX

TITLE

public static final PtcGlobalVariable TITLE

ORIGIN

public static final PtcGlobalVariable ORIGIN

DATE

public static final PtcGlobalVariable DATE

TIME

public static final PtcGlobalVariable TIME

UNKNOWN

public static final PtcGlobalVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

fromMadxName

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

allOfType

public static final java.util.Set<PtcGlobalVariable> allOfType(MadxVarType varType)

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.

getUnit

public java.lang.String getUnit()

Specified by:

getUnit in interface Variable

Returns:

a string, that represents the unit of the variable

getVarType

public MadxVarType getVarType()

Specified by:

getVarType in interface MadxVariable

Returns:

the type (String/Double) 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<PtcGlobalVariable>

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