Package xal.smf.impl

Class PermanentMagnet

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.PermanentMagnet

All Implemented Interfaces:

Comparable, ElementType, MagnetType, DataListener

Direct Known Subclasses:

PermQuadrupole

public abstract class PermanentMagnet
extends Magnet

PermanentMagnet is the superclass of all permanent magnet classes.

Author:

tap

Field Summary

Fields

Modifier and Type	Field	Description
final AccessibleProperty	field

Fields inherited from class xal.smf.impl.Magnet

bucMagnet

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, 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	Description
PermanentMagnet(String strId)	Creates new PermanentMagnet
PermanentMagnet(String strId, ChannelFactory channelFactory)	Creates new PermanentMagnet

Method Summary

Modifier and Type	Method	Description
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(String propertyName)	Get the array of channels for the specified property
double	getLivePropertyValue(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, getConversionFactor, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getOrientation, getPolarity, getTangField, isCorrector, isHorizontal, isMagnet, isPole, isSkew, isVertical, setDfltField, setMagBucket

Methods inherited from class xal.smf.AcceleratorNode

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLength, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getSoftType, getStatus, getTwiss, getType, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isKindOf, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, update, write, writeAttributes, writeStatus

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 Details

field

public final AccessibleProperty field

Constructor Details

PermanentMagnet

public PermanentMagnet(String strId,
 ChannelFactory channelFactory)

Creates new PermanentMagnet

PermanentMagnet

public PermanentMagnet(String strId)

Creates new PermanentMagnet

Method Details

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.

getLivePropertyValue

public double getLivePropertyValue(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(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.