Package 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:

Comparable, ElementType, MagnetType, DataListener

public class ExtractionKicker
extends Dipole

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	node type
final AccessibleProperty	voltage
static final String	VOLTAGE_RB_HANDLE	voltage readback handle
static final String	VOLTAGE_SET_HANDLE	voltage setting handle

Fields inherited from class xal.smf.impl.Electromagnet

field, FIELD_RB_HANDLE, fieldFromCurrent, fieldRBProperty, mainSupplyId, useFieldReadback

Fields inherited from class xal.smf.impl.Magnet

bucMagnet

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, 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	Description
ExtractionKicker(String strId)	Constructor
ExtractionKicker(String strId, ChannelFactory channelFactory)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
int	getOrientation()	Get the orientation of the magnet as defined by MagnetType.
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, getDfltBendAngle, getDfltPathLength, getEntrRotAngle, getExitRotAngle, getQuadComponent, isPole

Methods inherited from class xal.smf.impl.Electromagnet

findChannel, getAccessibleProperties, getCurrent, getCycleState, getDefaultHandles, getField, getFieldInt, getFieldReadback, getFieldSetting, getHandles, getMainSupply, getReadbackHandles, getSetHandle, getTotalFieldSetting, isChannelSettable, isPermanent, lowerAlarmFieldLimit, lowerCurrentLimit, lowerDisplayFieldLimit, lowerFieldLimit, lowerWarningFieldLimit, setCurrent, setCycleEnable, setField, setMainSupplyId, setUseFieldReadback, toCAFromField, toCurrentFromField, toFieldFromCA, toFieldFromCurrent, update, updatePowerSupplies, upperAlarmFieldLimit, upperCurrentLimit, upperDisplayFieldLimit, upperFieldLimit, upperWarningFieldLimit, useFieldReadback, write, writePowerSupplies

Methods inherited from class xal.smf.impl.Magnet

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

Methods inherited from class xal.smf.AcceleratorNode

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, getAccelerator, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, writeAttributes, writeStatus

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 Details

TYPE

public static final String TYPE

node type

See Also:

• Constant Field Values

VOLTAGE_RB_HANDLE

public static final String VOLTAGE_RB_HANDLE

voltage readback handle

See Also:

• Constant Field Values

VOLTAGE_SET_HANDLE

public static final String VOLTAGE_SET_HANDLE

voltage setting handle

See Also:

• Constant Field Values

voltage

public final AccessibleProperty voltage

Constructor Details

ExtractionKicker

public ExtractionKicker(String strId,
 ChannelFactory channelFactory)

Primary Constructor

ExtractionKicker

public ExtractionKicker(String strId)

Constructor

Method Details

getType

public 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 GetException

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

Returns:

the power supply voltage readback

Throws:

GetException

getVoltageSetting

public double getVoltageSetting()
                         throws GetException

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

Returns:

the power supply voltage setting

Throws:

GetException

setVoltage

public void setVoltage(double voltage)
                throws PutException

Set this kicker's power supply voltage

Parameters:

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

Throws:

PutException