Package xal.smf.impl

Class HDipoleCorr

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Dipole

xal.smf.impl.DipoleCorr

xal.smf.impl.HDipoleCorr

All Implemented Interfaces:

Comparable, ElementType, MagnetType, DataListener

public class HDipoleCorr
extends DipoleCorr

The implementation of the Horizontal Dipole corrector element.

Author:

J. Galambos (jdg@ornl.gov), Blaz Kranjc

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	standard type for nodes of this class

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
HDipoleCorr(String strId)	Constructor
HDipoleCorr(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

Methods inherited from class xal.smf.impl.DipoleCorr

isCorrector

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

standard type for nodes of this class

See Also:

• Constant Field Values

Constructor Details

HDipoleCorr

public HDipoleCorr(String strId,
 ChannelFactory channelFactory)

Primary Constructor

HDipoleCorr

public HDipoleCorr(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 horizontal correctors is HORIZONTAL.

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Magnet

Returns:

HORIZONTAL