gov.sns.xal.smf.impl
Class PermanentMagnet

java.lang.Object
  |
  +--gov.sns.xal.smf.AcceleratorNode
        |
        +--gov.sns.xal.smf.impl.Magnet
              |
              +--gov.sns.xal.smf.impl.PermanentMagnet

All Implemented Interfaces:

DataListener, ElementType, MagnetType

Direct Known Subclasses:

PermQuadrupole

public abstract class PermanentMagnet

extends Magnet

PermanentMagnet is the superclass of all permanent magnet classes.

Field Summary

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

PermanentMagnet(java.lang.String strId)
Creates new PermanentMagnet

Method Summary

double	getField() returns the field of the magnet (T /(m^ (n-1))), n=1 for dipole, 2 for quad etc.
double	getFieldInt() returns the integrated field of the magnet (T-m /(m^ (n-1))), n=1 for dipole, 2 for quad etc.
boolean	isPermanent() Since this is a permanent magnet we override the inherited method to advertise this characteristic.

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

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

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

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

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

Constructor Detail

PermanentMagnet

public PermanentMagnet(java.lang.String strId)

Creates new PermanentMagnet

Method Detail

isPermanent

public boolean isPermanent()

Since this is a permanent magnet we override the inherited method to advertise this characteristic.

Specified by:

isPermanent in interface MagnetType

Overrides:

isPermanent in class Magnet

Returns:

true since all PermanentMagnet instances are permanent magnets.

getField

public double getField()

returns the field of the magnet (T /(m^ (n-1))), n=1 for dipole, 2 for quad etc.

getFieldInt

public double getFieldInt()

returns the integrated field of the magnet (T-m /(m^ (n-1))), n=1 for dipole, 2 for quad etc.