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

Enum MadxGlobalVariable

java.lang.Object

java.lang.Enum<MadxGlobalVariable>

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

All Implemented Interfaces:

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

public enum MadxGlobalVariable
extends java.lang.Enum<MadxGlobalVariable>
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
ALFA
BCURRENT
BETXMAX
BETYMAX
CHARGE
DATE
DELTAP
DQ1
DQ2
DXMAX
DXRMS
DYMAX
DYRMS
ENERGY
ET
EX
EY
GAMMA
GAMMATR
KBUNCH
LENGTH
MASS
NAME
NPART
ORBIT5
ORIGIN
PARTICLE
PC
Q1
Q2
SEQUENCE
SIGE
SIGT
SYNCH_1
SYNCH_2
SYNCH_3
SYNCH_4
SYNCH_5
TIME
TITLE
TYPE
UNKNOWN
XCOMAX
XCORMS
YCOMAX
YCORMS

Method Summary

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

TYPE

public static final MadxGlobalVariable TYPE

SEQUENCE

public static final MadxGlobalVariable SEQUENCE

PARTICLE

public static final MadxGlobalVariable PARTICLE

MASS

public static final MadxGlobalVariable MASS

CHARGE

public static final MadxGlobalVariable CHARGE

ENERGY

public static final MadxGlobalVariable ENERGY

PC

public static final MadxGlobalVariable PC

GAMMA

public static final MadxGlobalVariable GAMMA

KBUNCH

public static final MadxGlobalVariable KBUNCH

BCURRENT

public static final MadxGlobalVariable BCURRENT

SIGE

public static final MadxGlobalVariable SIGE

SIGT

public static final MadxGlobalVariable SIGT

NPART

public static final MadxGlobalVariable NPART

EX

public static final MadxGlobalVariable EX

EY

public static final MadxGlobalVariable EY

ET

public static final MadxGlobalVariable ET

LENGTH

public static final MadxGlobalVariable LENGTH

ALFA

public static final MadxGlobalVariable ALFA

ORBIT5

public static final MadxGlobalVariable ORBIT5

GAMMATR

public static final MadxGlobalVariable GAMMATR

Q1

public static final MadxGlobalVariable Q1

Q2

public static final MadxGlobalVariable Q2

DQ1

public static final MadxGlobalVariable DQ1

DQ2

public static final MadxGlobalVariable DQ2

DXMAX

public static final MadxGlobalVariable DXMAX

DYMAX

public static final MadxGlobalVariable DYMAX

XCOMAX

public static final MadxGlobalVariable XCOMAX

YCOMAX

public static final MadxGlobalVariable YCOMAX

BETXMAX

public static final MadxGlobalVariable BETXMAX

BETYMAX

public static final MadxGlobalVariable BETYMAX

XCORMS

public static final MadxGlobalVariable XCORMS

YCORMS

public static final MadxGlobalVariable YCORMS

DXRMS

public static final MadxGlobalVariable DXRMS

DYRMS

public static final MadxGlobalVariable DYRMS

DELTAP

public static final MadxGlobalVariable DELTAP

SYNCH_1

public static final MadxGlobalVariable SYNCH_1

SYNCH_2

public static final MadxGlobalVariable SYNCH_2

SYNCH_3

public static final MadxGlobalVariable SYNCH_3

SYNCH_4

public static final MadxGlobalVariable SYNCH_4

SYNCH_5

public static final MadxGlobalVariable SYNCH_5

TITLE

public static final MadxGlobalVariable TITLE

ORIGIN

public static final MadxGlobalVariable ORIGIN

DATE

public static final MadxGlobalVariable DATE

TIME

public static final MadxGlobalVariable TIME

UNKNOWN

public static final MadxGlobalVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static MadxGlobalVariable 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 MadxGlobalVariable fromMadxName(java.lang.String madxName)

allOfType

public static final java.util.Set<MadxGlobalVariable> 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<MadxGlobalVariable>

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