xal.smf.impl

Class Dipole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Dipole

All Implemented Interfaces:

ElementType, MagnetType, DataListener

Direct Known Subclasses:

Bend, ExtractionKicker, HDipoleCorr, VDipoleCorr

public abstract class Dipole
extends Electromagnet

The implementation of the Dipole element. This class contains the basic members and methods of main dipoles. Note that there are other classes (e.g. dipoleCorr) that extend this class.

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 type for this device

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
Dipole(java.lang.String strID) Constructor

Method Summary

Modifier and Type	Method and Description
double	getBendAngle() returns design bend angle of the dipole (deg)
java.lang.String	getType() get the type
boolean	isPole(java.lang.String pole) Determine if this magnet has the specified pole

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, getOrientation, getPolarity, getTangField, isCorrector, 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

type for this device

See Also:

Constant Field Values

Constructor Detail

Dipole

public Dipole(java.lang.String strID)

Constructor

Parameters:

strID - the dipole's unique ID

Method Detail

getType

public java.lang.String getType()

get the type

Specified by:

getType in class AcceleratorNode

isPole

public boolean isPole(java.lang.String pole)

Determine if this magnet has the specified pole

Specified by:

isPole in interface MagnetType

Overrides:

isPole in class Magnet

Parameters:

pole - the pole against which to compare this magnet's pole

Returns:

true if the magnet is of the specified pole.

getBendAngle

public double getBendAngle()

returns design bend angle of the dipole (deg)