xal.extension.twissobserver

Enum TransferMatrixGenerator.SYNC

java.lang.Object

java.lang.Enum<TransferMatrixGenerator.SYNC>

xal.extension.twissobserver.TransferMatrixGenerator.SYNC

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TransferMatrixGenerator.SYNC>

Enclosing class:

TransferMatrixGenerator

public static enum TransferMatrixGenerator.SYNC
extends java.lang.Enum<TransferMatrixGenerator.SYNC>

Enumeration set representing the possible synchronization modes of the Scenario class.

Since:

Jul 19, 2012

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESIGN Synchronize the machine parameters to their design values
DESIGNRF Synchronize to the current live values, except for the RF parameter which are design
LIVE Synchronize the machine parameters to the current live values

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSynchronizationValue() Returns the value of the synchronization mode represented by this constant, as used by the Scenario class.
static TransferMatrixGenerator.SYNC	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TransferMatrixGenerator.SYNC[]	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

LIVE

public static final TransferMatrixGenerator.SYNC LIVE

Synchronize the machine parameters to the current live values

DESIGNRF

public static final TransferMatrixGenerator.SYNC DESIGNRF

Synchronize to the current live values, except for the RF parameter which are design

DESIGN

public static final TransferMatrixGenerator.SYNC DESIGN

Synchronize the machine parameters to their design values

Method Detail

values

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

Returns:

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

valueOf

public static TransferMatrixGenerator.SYNC 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

getSynchronizationValue

public java.lang.String getSynchronizationValue()

Returns the value of the synchronization mode represented by this constant, as used by the Scenario class.

Returns:

string value of the synchronization mode

Since:

Jul 19, 2012

See Also:

Scenario.setSynchronizationMode(String)