public abstract class Magnet extends AcceleratorNode implements MagnetType
Modifier and Type | Field and Description |
---|---|
double |
leff
The effective magnetic length (m)
|
protected MagnetBucket |
m_bucMagnet
The container for the magnet information
|
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
DIPOLE, HORIZONTAL, NO_ORIENTATION, OCT, OCTUPOLE, poles, QUAD, QUADRUPOLE, SEXT, SEXTUPOLE, SOL, SOLENOID, VERTICAL
Constructor and Description |
---|
Magnet(java.lang.String strId) |
Modifier and Type | Method and Description |
---|---|
void |
addBucket(AttributeBucket buc)
Override AcceleratorNode implementation to check for a MultipoleBucket
|
double |
getDesignField()
get the design field for the magnet (T for dipole, T/m for quad, etc.)
|
double |
getDfltField()
get the default magnetic field
|
double |
getEffLength()
get the effective magnetic length (m)
|
MagnetBucket |
getMagBucket() |
double[] |
getNormField()
get Normal fields
|
int |
getOrientation()
Get the orientation of the magnet as defined by MagnetType.
|
double |
getPolarity()
get magnet polarity
|
double[] |
getTangField()
get tangential fields
|
boolean |
isCorrector()
Determine whether this magnet is a corrector.
|
boolean |
isHorizontal()
Determine whether this magnet is oriented horizontally.
|
boolean |
isMagnet()
Override the inherited method to be true since all magnets are of the
magnet type.
|
boolean |
isPermanent()
Get whether this magnet is a permanent magnet or an electromagnet.
|
boolean |
isPole(java.lang.String compPole)
Test if the magnet is of the specified pole type.
|
boolean |
isSkew()
Determine whether this magnet is a skew magnet.
|
boolean |
isVertical()
Determine whether this magnet is oriented vertically.
|
void |
setDfltField(double field)
Method setDfltField
|
void |
setMagBucket(MagnetBucket buc)
Set the attribute bucket containing the machine magnet info
|
channelSuite, clear, dataLabel, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getType, 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, update, write
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isKindOf
public double leff
protected MagnetBucket m_bucMagnet
public MagnetBucket getMagBucket()
public void setMagBucket(MagnetBucket buc)
public void addBucket(AttributeBucket buc)
addBucket
in class AcceleratorNode
public boolean isMagnet()
isMagnet
in interface ElementType
isMagnet
in class AcceleratorNode
public boolean isPole(java.lang.String compPole)
isPole
in interface MagnetType
compPole
- Comparison pole which should be one of MagnetType.polespublic int getOrientation()
getOrientation
in interface MagnetType
public final boolean isHorizontal()
isHorizontal
in interface MagnetType
public final boolean isVertical()
isVertical
in interface MagnetType
public boolean isSkew()
isSkew
in interface MagnetType
public boolean isPermanent()
isPermanent
in interface MagnetType
public boolean isCorrector()
isCorrector
in interface MagnetType
public double getDesignField()
public double getEffLength()
public double getDfltField()
public double getPolarity()
public double[] getNormField()
public double[] getTangField()
public void setDfltField(double field)
field
- the default magnetic field to be changed to.