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

Enum MadxApertureGlobalVariable

java.lang.Object

java.lang.Enum<MadxApertureGlobalVariable>

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

All Implemented Interfaces:

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

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

Special global variables for aperture files.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_ELEMENT
BETA_BEATING
BETAQFX
CO_RADIUS
DP_BUCKET_SIZE
DQF
EXN
EYN
HALO_H
HALO_PRIM
HALO_R
HALO_V
N1MIN
NB_OF_ANGLES
PARAS_DX
PARAS_DY
TWISS_DELTAP
UNKNOWN

Method Summary

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

EXN

public static final MadxApertureGlobalVariable EXN

EYN

public static final MadxApertureGlobalVariable EYN

DQF

public static final MadxApertureGlobalVariable DQF

BETAQFX

public static final MadxApertureGlobalVariable BETAQFX

PARAS_DX

public static final MadxApertureGlobalVariable PARAS_DX

PARAS_DY

public static final MadxApertureGlobalVariable PARAS_DY

DP_BUCKET_SIZE

public static final MadxApertureGlobalVariable DP_BUCKET_SIZE

TWISS_DELTAP

public static final MadxApertureGlobalVariable TWISS_DELTAP

CO_RADIUS

public static final MadxApertureGlobalVariable CO_RADIUS

BETA_BEATING

public static final MadxApertureGlobalVariable BETA_BEATING

NB_OF_ANGLES

public static final MadxApertureGlobalVariable NB_OF_ANGLES

HALO_PRIM

public static final MadxApertureGlobalVariable HALO_PRIM

HALO_R

public static final MadxApertureGlobalVariable HALO_R

HALO_H

public static final MadxApertureGlobalVariable HALO_H

HALO_V

public static final MadxApertureGlobalVariable HALO_V

N1MIN

public static final MadxApertureGlobalVariable N1MIN

AT_ELEMENT

public static final MadxApertureGlobalVariable AT_ELEMENT

UNKNOWN

public static final MadxApertureGlobalVariable UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

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

fromMadxName

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