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

Enum MadxApertureVariable

java.lang.Object

java.lang.Enum<MadxApertureVariable>

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

All Implemented Interfaces:

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

public enum MadxApertureVariable
extends java.lang.Enum<MadxApertureVariable>
implements ApertureVariable

Enum Constant Summary

Enum Constants

Enum Constant	Description
APER_1
APER_2
APER_3
APER_4
APERTYPE
N1
N1X_M
N1Y_M
ON_AP
ON_ELEM
RTOL
SPEC
XTOL
YTOL

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

APER_1

public static final MadxApertureVariable APER_1

APER_2

public static final MadxApertureVariable APER_2

APER_3

public static final MadxApertureVariable APER_3

APER_4

public static final MadxApertureVariable APER_4

APERTYPE

public static final MadxApertureVariable APERTYPE

ON_AP

public static final MadxApertureVariable ON_AP

ON_ELEM

public static final MadxApertureVariable ON_ELEM

N1

public static final MadxApertureVariable N1

N1X_M

public static final MadxApertureVariable N1X_M

N1Y_M

public static final MadxApertureVariable N1Y_M

SPEC

public static final MadxApertureVariable SPEC

RTOL

public static final MadxApertureVariable RTOL

XTOL

public static final MadxApertureVariable XTOL

YTOL

public static final MadxApertureVariable YTOL

Method Detail

values

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

Returns:

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

valueOf

public static MadxApertureVariable 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.

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<MadxApertureVariable>

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

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)