xal.smf.attr

Class MagnetBucket

java.lang.Object

xal.smf.attr.AttributeBucket

xal.smf.attr.MagnetBucket

All Implemented Interfaces:

java.io.Serializable, DataListener

public class MagnetBucket
extends AttributeBucket

Attribute set for magnet information
len - is the effective magnetic length [m]
dfltMagField is the default field value (T for dipole, T/m for quad, etc.)
polarity - is the polarity flag. 1 means positive current = positive field. -1 means positive current = negative field
multFieldNorm - is an array of the normal direction multipole components element n is the n'th pole field level over the primary field where n= 0 for dipole, n=1 for quad, ...
multFieldSkew - is the same as multFieldNorm, but is for the skew direction

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.attr.AttributeBucket

AttributeBucket.MissingAttributeException

Constructor Summary

Constructors

Constructor and Description
MagnetBucket()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAttrNames()
double	getBendAngle() return the dipole bend angle (in degrees)
double	getDfltField() return the design magnetic field strength (in Tesla)
double	getDipoleEntrRotAngle() return the dipole rotation angle for entrance pole face (in degrees)
double	getDipoleExitRotAngle() return the dipole rotation angle for exit pole face (in degrees)
double	getDipoleQuadComponent() return the quadrupole component for bend dipole
double	getEffLength() return the magnetic length (in m)
double[]	getNormField()
double	getPathLength() return the design path length (in m)
double	getPolarity() return the magnet polarity ( 1 or -1)
double[]	getTangField()
java.lang.String	getType() Override virtual to provide type signature
void	setBendAngle(double dblVal) set the dipole bend angle (in degrees)
void	setDfltField(double dblVal)
void	setDipoleEntrRotAngle(double dblVal) set the dipole rotation angle for entrance pole face (in degrees)
void	setDipoleExitRotAngle(double dblVal) set the dipole rotation angle for exit pole face (in degrees)
void	setDipoleQuadComponent(double dblVal) set the quadrupole component for bend dipole
void	setEffLength(double dblVal) set the magnetic length (in m)
void	setNormField(double[] arrVal)
void	setPathLength(double dblVal) set the dipole path length (in m)
void	setPolarity(double dblVal) set the magnet polarity
void	setTangField(double[] arrVal)

Methods inherited from class xal.smf.attr.AttributeBucket

checkAttribute, dataLabel, getAttr, parseAttrValue, registerAttribute, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, update, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MagnetBucket

public MagnetBucket()

Method Detail

getType

public java.lang.String getType()

Override virtual to provide type signature

Specified by:

getType in class AttributeBucket

getAttrNames

public java.lang.String[] getAttrNames()

Overrides:

getAttrNames in class AttributeBucket

getEffLength

public double getEffLength()

return the magnetic length (in m)

getDfltField

public double getDfltField()

return the design magnetic field strength (in Tesla)

getPolarity

public double getPolarity()

return the magnet polarity ( 1 or -1)

getBendAngle

public double getBendAngle()

return the dipole bend angle (in degrees)

getNormField

public double[] getNormField()

getTangField

public double[] getTangField()

getPathLength

public double getPathLength()

return the design path length (in m)

getDipoleEntrRotAngle

public double getDipoleEntrRotAngle()

return the dipole rotation angle for entrance pole face (in degrees)

getDipoleExitRotAngle

public double getDipoleExitRotAngle()

return the dipole rotation angle for exit pole face (in degrees)

getDipoleQuadComponent

public double getDipoleQuadComponent()

return the quadrupole component for bend dipole

setEffLength

public void setEffLength(double dblVal)

set the magnetic length (in m)

Parameters:

dblVal - magnetic length in meters

setPolarity

public void setPolarity(double dblVal)

set the magnet polarity

Parameters:

dblVal - magnet polarity (1 or -1)

setBendAngle

public void setBendAngle(double dblVal)

set the dipole bend angle (in degrees)

Parameters:

dblVal - dipole bend angle in degrees

setNormField

public void setNormField(double[] arrVal)

setTangField

public void setTangField(double[] arrVal)

setDfltField

public void setDfltField(double dblVal)

setPathLength

public void setPathLength(double dblVal)

set the dipole path length (in m)

Parameters:

dblVal - path length in meters

setDipoleEntrRotAngle

public void setDipoleEntrRotAngle(double dblVal)

set the dipole rotation angle for entrance pole face (in degrees)

Parameters:

dblVal - dipole rotation angle for entrance pole face in degrees

setDipoleExitRotAngle

public void setDipoleExitRotAngle(double dblVal)

set the dipole rotation angle for exit pole face (in degrees)

Parameters:

dblVal - dipole rotation angle for exit pole face in degrees

setDipoleQuadComponent

public void setDipoleQuadComponent(double dblVal)

set the quadrupole component for bend dipole

Parameters:

dblVal - quadrupole component for bend dipole