Package xal.smf.attr

Class DipoleBucket

java.lang.Object

xal.smf.attr.AttributeBucket

xal.smf.attr.MagnetBucket

xal.smf.attr.DipoleBucket

All Implemented Interfaces:

Serializable, DataListener

Direct Known Subclasses:

DipoleBucket, DipoleCorrBucket

public class DipoleBucket
extends MagnetBucket

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@ess.eu>

See Also:

• Serialized Form

Nested Class Summary

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

AttributeBucket.MissingAttributeException

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	ARR_NAMES
protected Attribute	attBendAngle
protected Attribute	attDipoleEntrRotAngle
protected Attribute	attDipoleExitRotAngle
protected Attribute	attDipoleQuadComponent

Constructor Summary

Constructors

Constructor	Description
DipoleBucket()

Method Summary

Modifier and Type	Method	Description
double	getBendAngle()	return the dipole bend angle (in degrees)
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	getPathLength()	return the design path length (in m)
String	getType()	Override virtual to provide type signature
void	setBendAngle(double dblVal)	set the dipole bend angle (in degrees)
void	setDipoleEntrRotAngle(double dblVal)
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	setPathLength(double dblVal)	set the dipole path length (in m)

Methods inherited from class xal.smf.attr.MagnetBucket

getConversionFactor, getDfltField, getEffLength, getNormField, getPolarity, getTangField, getUseCurrentFlag, setConversionFactor, setDfltField, setEffLength, setNormField, setPolarity, setTangField, setUseCurrentFlag

Methods inherited from class xal.smf.attr.AttributeBucket

checkAttribute, dataLabel, getAttr, getAttrDescription, getAttrNames, parseAttrValue, registerAttribute, 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

Field Details

attBendAngle

protected Attribute attBendAngle

attDipoleEntrRotAngle

protected Attribute attDipoleEntrRotAngle

attDipoleExitRotAngle

protected Attribute attDipoleExitRotAngle

attDipoleQuadComponent

protected Attribute attDipoleQuadComponent

ARR_NAMES

protected static final String[] ARR_NAMES

Constructor Details

DipoleBucket

public DipoleBucket()

Method Details

getType

public String getType()

Override virtual to provide type signature

Overrides:

getType in class MagnetBucket

getBendAngle

public double getBendAngle()

return the dipole bend angle (in degrees)

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

setBendAngle

public void setBendAngle(double dblVal)

set the dipole bend angle (in degrees)

Parameters:

dblVal - dipole bend angle in degrees

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)

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