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

Class Kicker

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

org.scictrl.mp.orbitcorrect.model.optics.Kicker

All Implemented Interfaces:

Cloneable, ISimpleElement, AbstractUpdateableElement, IApplyableElement

public class Kicker
extends AbstractCorrector

This type represent kicker magnet. This is corrector, which is modeled as it would change direction of particle's velocity discontinously inthe center of it for a specified angle.

Author:

igor@scictrl.com

See Also:

• HorCorrector

Field Summary

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

PR_ANGLE

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

calc, 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
Kicker(String name)	Constructs Kicker with specified name and default parameter's values.
Kicker(String name, boolean virtual, double position, double relpos, String relFrom, double length, String ps, String calibrationEntry, double angle)	Constructs the Kicker 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.

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

addToAngle, applyAngle, clone, getAngle, getMaxAngle, getMinAngle, setAngle, setCurrent, setWith, toString, 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, 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

Constructor Details

Kicker

public Kicker(String name)

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

Parameters:

name - a String name of abstract corrector

Kicker

public Kicker(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom,
 double length,
 String ps,
 String calibrationEntry,
 double angle)

Constructs the Kicker 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

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