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

Comparable, ElementType, MagnetType, DataListener

Direct Known Subclasses:

Bend, DipoleCorr, ExtractionKicker

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.

Author:

J. Galambos (jdg@ornl.gov)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	type for this device

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

Modifier	Constructor	Description
protected	Dipole(String strID)	Constructor
	Dipole(String strId, ChannelFactory channelFactory)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
double	getBendAngle()	returns design bend angle of the dipole (deg)
double	getDfltBendAngle()	Get the dipole bend magnet bending angle.
double	getDfltPathLength()	returns design path length in meters
double	getEntrRotAngle()	returns dipole rotation angle for entrance pole face (deg)
double	getExitRotAngle()	returns dipole rotation angle for exit pole face (deg)
double	getQuadComponent()	returns quadrupole component for bend dipole
String	getType()	get the type
boolean	isPole(String pole)	Determine if this magnet has the specified pole

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

type for this device

See Also:

• Constant Field Values

Constructor Details

Dipole

public Dipole(String strId,
 ChannelFactory channelFactory)

Primary Constructor

Dipole

protected Dipole(String strID)

Constructor

Parameters:

strID - the dipole's unique ID

Method Details

getType

public String getType()

get the type

Specified by:

getType in class AcceleratorNode

isPole

public boolean isPole(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)

getDfltBendAngle

public double getDfltBendAngle()

Get the dipole bend magnet bending angle.

getDfltPathLength

public double getDfltPathLength()

returns design path length in meters

getEntrRotAngle

public double getEntrRotAngle()

returns dipole rotation angle for entrance pole face (deg)

getExitRotAngle

public double getExitRotAngle()

returns dipole rotation angle for exit pole face (deg)

getQuadComponent

public double getQuadComponent()

returns quadrupole component for bend dipole