xal.smf.impl

Class ExtractionKicker

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Dipole

xal.smf.impl.ExtractionKicker

All Implemented Interfaces:

ElementType, MagnetType, DataListener

public class ExtractionKicker
extends Dipole

the extraction kicker represents a pulsed magnet for extracting the beam vertically from the ring

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.impl.Electromagnet

Electromagnet.Property

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType node type
static java.lang.String	VOLTAGE_RB_HANDLE voltage readback handle
static java.lang.String	VOLTAGE_SET_HANDLE voltage setting handle

Fields inherited from class xal.smf.impl.Electromagnet

_useFieldReadback, FIELD_RB_HANDLE, mainSupplyId

Fields inherited from class xal.smf.impl.Magnet

leff, m_bucMagnet

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Fields inherited from interface xal.smf.impl.qualify.MagnetType

DIPOLE, HORIZONTAL, NO_ORIENTATION, OCT, OCTUPOLE, poles, QUAD, QUADRUPOLE, SEXT, SEXTUPOLE, SOL, SOLENOID, VERTICAL

Constructor Summary

Constructors

Constructor and Description
ExtractionKicker(java.lang.String strId) Constructor

Method Summary

Modifier and Type	Method and Description
int	getOrientation() Get the orientation of the magnet as defined by MagnetType.
java.lang.String	getType() Override to provide type signature
double	getVoltage() Get the voltage readback for this kicker's power supply.
double	getVoltageSetting() Get the voltage setting for this kicker's power supply.
boolean	isCorrector() Determine whether this magnet is a corrector.
void	setVoltage(double voltage) Set this kicker's power supply voltage

Methods inherited from class xal.smf.impl.Dipole

getBendAngle, isPole

Methods inherited from class xal.smf.impl.Electromagnet

findChannel, getCurrent, getCycleState, getDesignPropertyValue, getField, getFieldInt, getFieldReadback, getFieldSetting, getHandles, getLivePropertyChannels, getLivePropertyValue, getMainSupply, getTotalFieldSetting, isPermanent, lowerAlarmFieldLimit, lowerCurrentLimit, lowerDisplayFieldLimit, lowerFieldLimit, lowerWarningFieldLimit, setCurrent, setCycleEnable, setField, setUseFieldReadback, toCAFromField, toFieldFromCA, update, updatePowerSupplies, upperAlarmFieldLimit, upperCurrentLimit, upperDisplayFieldLimit, upperFieldLimit, upperWarningFieldLimit, useFieldReadback, write, writePowerSupplies

Methods inherited from class xal.smf.impl.Magnet

addBucket, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getPolarity, getTangField, isHorizontal, isMagnet, isSkew, isVertical, setDfltField, setMagBucket

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, dataLabel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getEId, getId, getLength, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface xal.smf.impl.qualify.ElementType

isKindOf

Field Detail

s_strType

public static final java.lang.String s_strType

node type

See Also:

Constant Field Values

VOLTAGE_RB_HANDLE

public static final java.lang.String VOLTAGE_RB_HANDLE

voltage readback handle

See Also:

Constant Field Values

VOLTAGE_SET_HANDLE

public static final java.lang.String VOLTAGE_SET_HANDLE

voltage setting handle

See Also:

Constant Field Values

Constructor Detail

ExtractionKicker

public ExtractionKicker(java.lang.String strId)

Constructor

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Overrides:

getType in class Dipole

getOrientation

public int getOrientation()

Get the orientation of the magnet as defined by MagnetType. The orientation of all vertical correctors is VERTICAL.

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Magnet

Returns:

VERTICAL

isCorrector

public boolean isCorrector()

Determine whether this magnet is a corrector.

Specified by:

isCorrector in interface MagnetType

Overrides:

isCorrector in class Magnet

Returns:

false

getVoltage

public double getVoltage()
                  throws ConnectionException,
                         GetException

Get the voltage readback for this kicker's power supply.

Returns:

the power supply voltage readback

Throws:

ConnectionException

GetException

getVoltageSetting

public double getVoltageSetting()
                         throws ConnectionException,
                                GetException

Get the voltage setting for this kicker's power supply.

Returns:

the power supply voltage setting

Throws:

ConnectionException

GetException

setVoltage

public void setVoltage(double voltage)
                throws ConnectionException,
                       PutException

Set this kicker's power supply voltage

Parameters:

voltage - is the new voltage to apply to the power supply.

Throws:

ConnectionException

PutException