xal.smf.impl

Class VDipoleCorr

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Dipole

xal.smf.impl.VDipoleCorr

All Implemented Interfaces:

ElementType, MagnetType, DataListener

public class VDipoleCorr
extends Dipole

The implementation of the Vertical Dipole corrector element. This class extends the dipole class, and is meant to hold dipole objects that are specifically correctors.

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

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
VDipoleCorr(java.lang.String strId)

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
boolean	isCorrector() Determine whether this magnet is a corrector.

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

See Also:

Constant Field Values

Constructor Detail

VDipoleCorr

public VDipoleCorr(java.lang.String strId)

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:

true since vertical correctors are always correctors.