gov.sns.xal.smf.impl
Class HDipoleCorr

java.lang.Object
  |
  +--gov.sns.xal.smf.AcceleratorNode
        |
        +--gov.sns.xal.smf.impl.Magnet
              |
              +--gov.sns.xal.smf.impl.Electromagnet
                    |
                    +--gov.sns.xal.smf.impl.Dipole
                          |
                          +--gov.sns.xal.smf.impl.HDipoleCorr

All Implemented Interfaces:

DataListener, ElementType, MagnetType

public class HDipoleCorr

extends Dipole

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

Field Summary

static java.lang.String

s_strType

Fields inherited from class gov.sns.xal.smf.impl.Electromagnet

FIELD_RB_HANDLE, mainSupplyId

Fields inherited from class gov.sns.xal.smf.impl.Magnet

leff, m_bucMagnet

Fields inherited from class gov.sns.xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_mapAttrs, m_objAccel, m_seqParent, m_strId

Fields inherited from interface gov.sns.xal.smf.impl.qualify.MagnetType

DIPOLE, HORIZONTAL, NO_ORIENTATION, OCT, OCTUPOLE, poles, QUAD, QUADRUPOLE, SEXT, SEXTUPOLE, VERTICAL

Constructor Summary

HDipoleCorr(java.lang.String strId)

Method Summary

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 gov.sns.xal.smf.impl.Dipole

getBendAngle, getField, isPole, lowerFieldLimit, setField, upperFieldLimit

Methods inherited from class gov.sns.xal.smf.impl.Electromagnet

getChannel, getCurrent, getCycleState, getFieldInt, getHandles, getMainSupply, isPermanent, lowerCurrentLimit, setCurrent, setCycleEnable, update, updatePowerSupplies, upperCurrentLimit, write, writePowerSupplies

Methods inherited from class gov.sns.xal.smf.impl.Magnet

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

Methods inherited from class gov.sns.xal.smf.AcceleratorNode

channelSuite, clear, dataLabel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getId, getLength, getParent, getPosition, getStatus, getTwiss, getValid, hasBucket, hasParent, isKindOf, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPosition, setStatus, setTwiss, setValid, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gov.sns.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

HDipoleCorr

public HDipoleCorr(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

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

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 horizontal correctors are always correctors.