xal.smf.impl

Class PermanentMagnet

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.PermanentMagnet

All Implemented Interfaces:

ElementType, MagnetType, DataListener

Direct Known Subclasses:

PermQuadrupole

public abstract class PermanentMagnet
extends Magnet

PermanentMagnet is the superclass of all permanent magnet classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermanentMagnet.Property accessible properties

Field Summary

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
PermanentMagnet(java.lang.String strId) Creates new PermanentMagnet

Method Summary

Modifier and Type	Method and Description
double	getDesignPropertyValue(java.lang.String propertyName) Get the design value for the specified property
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.
Channel[]	getLivePropertyChannels(java.lang.String propertyName) Get the array of channels for the specified property
double	getLivePropertyValue(java.lang.String propertyName, double[] channelValues) Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()
boolean	isPermanent() Since this is a permanent magnet we override the inherited method to advertise this characteristic.

Methods inherited from class xal.smf.impl.Magnet

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

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, dataLabel, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getEId, getHandles, getId, getLength, 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

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

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.

getDesignPropertyValue

public double getDesignPropertyValue(java.lang.String propertyName)

Get the design value for the specified property

Overrides:

getDesignPropertyValue in class AcceleratorNode

getLivePropertyValue

public double getLivePropertyValue(java.lang.String propertyName,
                                   double[] channelValues)

Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()

Overrides:

getLivePropertyValue in class AcceleratorNode

getLivePropertyChannels

public Channel[] getLivePropertyChannels(java.lang.String propertyName)

Get the array of channels for the specified property

Overrides:

getLivePropertyChannels in class AcceleratorNode

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.