Package xal.extension.jels.smf.attr

Class DipoleBucket

java.lang.Object

xal.smf.attr.AttributeBucket

xal.smf.attr.MagnetBucket

xal.smf.attr.DipoleBucket

xal.extension.jels.smf.attr.DipoleBucket

All Implemented Interfaces:

Serializable, DataListener

public class DipoleBucket
extends DipoleBucket

Attribute set for additional magnet information about Fringe-Fields factors
gap - total gap of magnet (m) entrK1 - Upstream edge face Fringe-field factor (default = 0.45 for a square-edged magnet) entrK2 - Upstream edge face Fringe-field factor (default = 2.80 for a square-edged magnet) exitK1 - Downstream edge face Fringe-field factor (default = 0.45 for a square-edged magnet) exitK2 - Downstream edge face Fringe-field factor (default = 2.80 for a square-edged magnet)

Author:

Ivo List, 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 inherited from class xal.smf.attr.DipoleBucket

attBendAngle, attDipoleEntrRotAngle, attDipoleExitRotAngle, attDipoleQuadComponent

Constructor Summary

Constructors

Constructor	Description
DipoleBucket()

Method Summary

Modifier and Type	Method	Description
double	getEntrFringeFieldFactorK1()
double	getEntrFringeFieldFactorK2()
double	getExitFringeFieldFactorK1()
double	getExitFringeFieldFactorK2()
double	getGap()
int	getOrientation()
void	setEntrFringeFieldFactorK1(double value)
void	setEntrFringeFieldFactorK2(double value)
void	setExitFringeFieldFactorK1(double value)
void	setExitFringeFieldFactorK2(double value)
void	setGap(double value)
void	setOrientation(int intVal)

Methods inherited from class xal.smf.attr.DipoleBucket

getBendAngle, getDipoleEntrRotAngle, getDipoleExitRotAngle, getDipoleQuadComponent, getPathLength, getType, setBendAngle, setDipoleEntrRotAngle, setDipoleExitRotAngle, setDipoleQuadComponent, setPathLength

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

Constructor Details

DipoleBucket

public DipoleBucket()

Method Details

getGap

public double getGap()

Returns:

total gap of magnet (m)

setGap

public void setGap(double value)

Parameters:

value - total gap of magnet (m)

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int intVal)

getEntrFringeFieldFactorK1

public double getEntrFringeFieldFactorK1()

Returns:

Upstream edge face Fringe-field factor (default = 0.45)

setEntrFringeFieldFactorK1

public void setEntrFringeFieldFactorK1(double value)

Parameters:

value - Upstream edge face Fringe-field factor (default = 0.45)

getEntrFringeFieldFactorK2

public double getEntrFringeFieldFactorK2()

Returns:

Upstream edge face Fringe-field factor (default = 2.80)

setEntrFringeFieldFactorK2

public void setEntrFringeFieldFactorK2(double value)

Parameters:

value - Upstream edge face Fringe-field factor (default = 2.80)

getExitFringeFieldFactorK1

public double getExitFringeFieldFactorK1()

Returns:

Downstream edge face Fringe-field factor (default = 0.45)

setExitFringeFieldFactorK1

public void setExitFringeFieldFactorK1(double value)

Parameters:

value - Downstream edge face Fringe-field factor (default = 0.45)

getExitFringeFieldFactorK2

public double getExitFringeFieldFactorK2()

Returns:

Downstream edge face Fringe-field factor (default = 2.80)

setExitFringeFieldFactorK2

public void setExitFringeFieldFactorK2(double value)

Parameters:

value - Downstream edge face Fringe-field factor (default = 2.80)