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

Class RBending

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.AbstractMagnetElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractCalibratedMagnet

org.scictrl.mp.orbitcorrect.model.optics.AbstractBending

org.scictrl.mp.orbitcorrect.model.optics.RBending

All Implemented Interfaces:

Cloneable, ISimpleElement, AbstractUpdateableElement, IApplyableElement

public class RBending
extends AbstractBending

This type represent rectangular dipole magnet. It has parallel side faces and additional wedge foccusing.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PR_LEFT_WEDGE_ANGLE	Constant PR_LEFT_WEDGE_ANGLE=12
static final int	PR_RIGHT_WEDGE_ANGLE	Constant PR_RIGHT_WEDGE_ANGLE=13

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

PR_DFIELD, PR_ENERGY, PR_QUADRUPOLE_STRENGTH, PR_RADIUS, quadrupoleStrength, radius

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

calibrationEntry, current, dataInvalidated, PR_CALIBRATION_ENTRY

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

PR_POWER_SUPPLY, psH

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
RBending(String name)	Constructs RBending with specified name and default parameter's values.
RBending(String name, boolean virtual, double position, double relpos, String relFrom, double length, String ps, String calibrationEntry, double quadrupoleStrength, double radius, double dipoleField, double energy, double lwedge, double rwedge)	Constructs the RBending 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	getLeftWedgeAngle()	Getter for the field leftWedgeAngle.
double	getRightWedgeAngle()	Getter for the field rightWedgeAngle.
TransferMatrix	newMatrix()	This method return transfer matrix of drift with the same length as this element.
TransferMatrix	newMatrix(double length)	This method return transfer matrix of drift with the specified length.
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.AbstractBending

applyField, clone, getCalculator, getDipoleField, getEnergy, getMaxEnergy, getMinEnergy, getQuadrupoleStrength, getRadius, setCurrent, setDipoleField, setEnergy, setQuadrupoleStrength, setRadius, update

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

getCalibrationEntry, getCurrent, invalidateData, isDataInvalidated, updateMatrices

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

getPowerSupply, getPS

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

getAlpha1, getAlpha2, getBeta1, getBeta2, getDispersion1, getDispersion2, getLength, getMatrix, getQ1, getQ2, 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_LEFT_WEDGE_ANGLE

public static final int PR_LEFT_WEDGE_ANGLE

Constant PR_LEFT_WEDGE_ANGLE=12

See Also:

• Constant Field Values

PR_RIGHT_WEDGE_ANGLE

public static final int PR_RIGHT_WEDGE_ANGLE

Constant PR_RIGHT_WEDGE_ANGLE=13

See Also:

• Constant Field Values

Constructor Details

RBending

public RBending(String name)

Constructs RBending with specified name and default parameter's values.

Parameters:

name - a String name of abstract bending

RBending

public RBending(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom,
 double length,
 String ps,
 String calibrationEntry,
 double quadrupoleStrength,
 double radius,
 double dipoleField,
 double energy,
 double lwedge,
 double rwedge)

Constructs the RBending with specified parameters.

Parameters:

name - a String object

virtual - a boolean

position - a double

relpos - a double

relFrom - a String object

length - a double

ps - a String object

calibrationEntry - a String object

quadrupoleStrength - a double

radius - a double

dipoleField - a double

energy - a double

lwedge - a double

rwedge - 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()

newMatrix

public TransferMatrix newMatrix()

This method return transfer matrix of drift with the same length as this element. This method return transfer matrix, calculated with current length, quadrupole strength and radius. This method return transfer matrix, calculated with current length, quadrupole strength and radius.

Overrides:

newMatrix in class AbstractBending

Returns:

a TransferMatrix object

See Also:

• TransferMatrix

newMatrix

public TransferMatrix newMatrix(double length)

This method return transfer matrix of drift with the specified length. This method return transfer matrix, calculated with current quadrupole strength, radius and as parameter specified length. This method return transfer matrix, calculated with current quadrupole strength, radius and as parameter specified length.

Overrides:

newMatrix in class AbstractBending

Parameters:

length - a double

Returns:

a TransferMatrix object

See Also:

• TransferMatrix

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.

toString.

toString.

Returns a String that represents the value of this object.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractBending

See Also:

• AbstractDataBushElement.toString()

getLeftWedgeAngle

public double getLeftWedgeAngle()

Getter for the field leftWedgeAngle.

Returns:

a double

getRightWedgeAngle

public double getRightWedgeAngle()

Getter for the field rightWedgeAngle.

Returns:

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.

setWith.

setWith.

setWith.

Overrides:

setWith in class AbstractBending

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

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