Package eu.ess.bled.devices.lattice

Class MultipoleMagnet

java.lang.Object

eu.ess.bled.Subsystem

eu.ess.bled.devices.lattice.BeamlineElement

eu.ess.bled.devices.lattice.Magnet

eu.ess.bled.devices.lattice.MultipoleMagnet

All Implemented Interfaces:

BLEDEntity, Serializable

Direct Known Subclasses:

Quadrupole

public class MultipoleMagnet
extends Magnet

MultipoleMagnet represents multi pole magnets in the beamline. It contains the strength and multipole gradients of a single magnet.

Author:

Jaka Bobnar

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MultipoleMagnet.MagnetType	MagnetType describes different types of multipoles.

Nested classes/interfaces inherited from class eu.ess.bled.devices.lattice.BeamlineElement

BeamlineElement.ApertureType

Constructor Summary

Constructors

Constructor	Description
MultipoleMagnet()

Method Summary

Modifier and Type	Method	Description
Double	getDecapoleGradient()
Double	getDipoleStrength()
Double	getDodecapoleGradient()
MultipoleMagnet.MagnetType	getMagnetType()
Double	getOctupoleGradient()
Double	getQuadrupoleGradient()
Double	getSextupoleGradient()
Double	getSolenoidLength()
Integer	getSolenoidSteps()
Integer	getSteps()
void	setDecapoleGradient(Double decapoleGradient)
void	setDipoleStrength(Double dipoleStrength)
void	setDodecapoleGradient(Double dodecapoleGradient)
void	setMagnetType(MultipoleMagnet.MagnetType magnetType)
void	setOctupoleGradient(Double octupoleGradient)
void	setQuadrupoleGradient(Double quadrupoleGradient)
void	setSextupoleGradient(Double sextupoleGradient)
void	setSolenoidLength(Double solenoidLength)
void	setSolenoidSteps(Integer solenoidSteps)
void	setSteps(Integer steps)

Methods inherited from class eu.ess.bled.devices.lattice.Magnet

getPowerSupply, getSkewAngle, setPowerSupply, setSkewAngle

Methods inherited from class eu.ess.bled.devices.lattice.BeamlineElement

getApertureType, getApertureX, getApertureY, getCorrectionElement, getLength, getOpticalLength, getPosition, getProperties, setApertureType, setApertureX, setApertureY, setCorrectionElement, setLength, setOpticalLength, setPosition, setProperties

Methods inherited from class eu.ess.bled.Subsystem

getDescription, getId, getInstanceName, getName, getParentSubsystem, getPreviousSubsystem, getSubsystemType, getValuesAsString, isActive, isVirtual, setActive, setDescription, setInstanceName, setName, setParentSubsystem, setPreviousSubsystem, setSubsystemType, setVirtual, toString

Methods inherited from class java.lang.Object

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

Constructor Details

MultipoleMagnet

public MultipoleMagnet()

Method Details

getDipoleStrength

public Double getDipoleStrength()

setDipoleStrength

public void setDipoleStrength(Double dipoleStrength)

getQuadrupoleGradient

public Double getQuadrupoleGradient()

setQuadrupoleGradient

public void setQuadrupoleGradient(Double quadrupoleGradient)

getSextupoleGradient

public Double getSextupoleGradient()

setSextupoleGradient

public void setSextupoleGradient(Double sextupoleGradient)

getOctupoleGradient

public Double getOctupoleGradient()

setOctupoleGradient

public void setOctupoleGradient(Double octupoleGradient)

getDecapoleGradient

public Double getDecapoleGradient()

setDecapoleGradient

public void setDecapoleGradient(Double decapoleGradient)

getDodecapoleGradient

public Double getDodecapoleGradient()

setDodecapoleGradient

public void setDodecapoleGradient(Double dodecapoleGradient)

getMagnetType

public MultipoleMagnet.MagnetType getMagnetType()

setMagnetType

public void setMagnetType(MultipoleMagnet.MagnetType magnetType)

getSteps

public Integer getSteps()

setSteps

public void setSteps(Integer steps)

getSolenoidLength

public Double getSolenoidLength()

setSolenoidLength

public void setSolenoidLength(Double solenoidLength)

getSolenoidSteps

public Integer getSolenoidSteps()

setSolenoidSteps

public void setSolenoidSteps(Integer solenoidSteps)