Package org.scictrl.mp.orbitcorrect.model.optics

Class Cavity

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

org.scictrl.mp.orbitcorrect.model.optics.Cavity

All Implemented Interfaces:

Cloneable, ISimpleElement

public class Cavity
extends AbstractTransferElement

Cavity represent cavity.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PR_BETRF	Constant PR_BETRF=9
static final int	PR_HARMON	Constant PR_HARMON=8
static final int	PR_LAG	Constant PR_LAG=7
static final int	PR_PG	Constant PR_PG=10
static final int	PR_SHUNT	Constant PR_SHUNT=11
static final int	PR_TFILL	Constant PR_TFILL=12
static final int	PR_VOLTAGE	Constant PR_VOLTAGE=6

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

length, matrices, matrix, PR_LENGTH

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

PR_POSITION, PR_REL_FROM, PR_REL_POSITION

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

lastActionResult, owner, PR_ELEMENT_NAME, PR_VIRTUAL

Constructor Summary

Constructors

Constructor	Description
Cavity(String name)	Cavity constructor that takes only name as parameter.
Cavity(String name, boolean virtual, double position, double relpos, String relFrom, double length, double voltage, double lag, int harmon, double betRF, double pG, double shunt, double tFill)	Constructs the Cavity with specified parameters.

Method Summary

Modifier and Type	Method	Description
DBElementDescriptor	descriptor()	Returns the descriptor object for this element.
int	elType()	Returns the code of element's type.
double	getBetRF()	Getter for the field betRF.
int	getHarmon()	Getter for the field harmon.
double	getLag()	Getter for the field lag.
double	getPG()	Getter for the field pG.
double	getShunt()	Getter for the field shunt.
double	getTFill()	Getter for the field tFill.
double	getVoltage()	This method return voltage on cavity.
void	setBetRF(double newValue)	Setter for the field betRF.
void	setHarmon(int newValue)	Setter for the field harmon.
void	setLag(double newValue)	Setter for the field lag.
void	setPG(double newValue)	Setter for the field pG.
void	setShunt(double newValue)	Setter for the field shunt.
void	setTFill(double newValue)	Setter for the field tFill.
void	setVoltage(double newValue)	This method set voltage to cavity.
void	setWith(Object[] par)	Sets parameters values of this element to those in parameter array.
String	toString()	Returns the string representation of this element.

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

clone, getAlpha1, getAlpha2, getBeta1, getBeta2, getDispersion1, getDispersion2, getLength, getMatrix, getQ1, getQ2, newMatrix, newMatrix, setLength

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

getAlpha, getBeta, getDispersion, getIndex, getPosition, getQ, getRelFrom, getRelPosition, setPosition, setRelFrom, setRelPosition

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

equals, getLastActionResult, getName, getOwner, getVirtual, hashCode, isInitialized, isVirtual, setVirtual, throwISE

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PR_VOLTAGE

public static final int PR_VOLTAGE

Constant PR_VOLTAGE=6

See Also:

• Constant Field Values

PR_LAG

public static final int PR_LAG

Constant PR_LAG=7

See Also:

• Constant Field Values

PR_HARMON

public static final int PR_HARMON

Constant PR_HARMON=8

See Also:

• Constant Field Values

PR_BETRF

public static final int PR_BETRF

Constant PR_BETRF=9

See Also:

• Constant Field Values

PR_PG

public static final int PR_PG

Constant PR_PG=10

See Also:

• Constant Field Values

PR_SHUNT

public static final int PR_SHUNT

Constant PR_SHUNT=11

See Also:

• Constant Field Values

PR_TFILL

public static final int PR_TFILL

Constant PR_TFILL=12

See Also:

• Constant Field Values

Constructor Details

Cavity

public Cavity(String name)

Cavity constructor that takes only name as parameter.

Parameters:

name - a String object

Cavity

public Cavity(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom,
 double length,
 double voltage,
 double lag,
 int harmon,
 double betRF,
 double pG,
 double shunt,
 double tFill)

Constructs the Cavity with specified parameters.

Parameters:

name - a String object

virtual - a boolean

position - a double

relpos - a double

relFrom - a String object

length - a double

voltage - a double

lag - a double

harmon - a int

betRF - a double

pG - a double

shunt - a double

tFill - a double

Method Details

descriptor

public DBElementDescriptor descriptor()

Returns the descriptor object for this element. DBElementDescriptor helps manipulating DataBush elements dynamically.

descriptor.

Specified by:

descriptor in class AbstractDataBushElement

Returns:

the descriptor object for this element.

See Also:

• AbstractDataBushElement.descriptor()

elType

public int elType()

Returns the code of element's type.

elType.

Specified by:

elType in class AbstractDataBushElement

Returns:

the code of element's type.

See Also:

• AbstractDataBushElement.elType()

getBetRF

public double getBetRF()

Getter for the field betRF.

Returns:

double

getHarmon

public int getHarmon()

Getter for the field harmon.

Returns:

int

getLag

public double getLag()

Getter for the field lag.

Returns:

double

getPG

public double getPG()

Getter for the field pG.

Returns:

double

getShunt

public double getShunt()

Getter for the field shunt.

Returns:

double

getTFill

public double getTFill()

Getter for the field tFill.

Returns:

double

getVoltage

public double getVoltage()

This method return voltage on cavity.

Returns:

double voltage value

setBetRF

public void setBetRF(double newValue)

Setter for the field betRF.

Parameters:

newValue - double

setHarmon

public void setHarmon(int newValue)

Setter for the field harmon.

Parameters:

newValue - int

setLag

public void setLag(double newValue)

Setter for the field lag.

Parameters:

newValue - double

setPG

public void setPG(double newValue)

Setter for the field pG.

Parameters:

newValue - double

setShunt

public void setShunt(double newValue)

Setter for the field shunt.

Parameters:

newValue - double

setTFill

public void setTFill(double newValue)

Setter for the field tFill.

Parameters:

newValue - double

setVoltage

public void setVoltage(double newValue)

This method set voltage to cavity.

Parameters:

newValue - a double

setWith

public void setWith(Object[] par)
             throws IllegalStateException

Sets parameters values of this element to those in parameter array. As parameter must be used such array as for dynamical construction of new instance of this class. Current values are overriden for each not null object in array.

setWith.

setWith.

setWith.

Overrides:

setWith in class AbstractTransferElement

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

• AbstractDataBushElement.setWith(java.lang.Object[])

toString

public String toString()

Returns the string representation of this element. Returns string describing this element. String is formated in input-file code. Returns a String that represents the value of this object.

toString.

toString.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractTransferElement

See Also:

• AbstractDataBushElement.toString()