Package eu.ess.bled.devices.lattice

Class BeamlineElement

java.lang.Object

eu.ess.bled.Subsystem

eu.ess.bled.devices.lattice.BeamlineElement

All Implemented Interfaces:

BLEDEntity, Serializable

Direct Known Subclasses:

Aperture, BPM, Corrector, Drift, DTLCell, ElectrostaticAcceleration, ElectrostaticBend, ElectrostaticQuadropole, FieldMap, Magnet, Marker, NCell, RFCavity, RFQCell, SpaceChargeCompensation, ThinLens

public class BeamlineElement
extends Subsystem

BeamlineElement is the base element of the lattice. Every element that is part of the lattice is an extension of this element, which is derived from the Subsystem. It defines the length, optical length, aperture size and position of the element in the ideal case. The length and position are the theoretical values of the two attributes as calculated during lattice design. In reality the attributes of the element might not be ideal, therefore they are corrected with a CorrectionElement. This element does not depend to a CorrectionElement and it can resides on its own, but if there is a CorrectionElement that depends on this BeamlineElement, those corrections need to be taken into account.

Author:

Jaka Bobnar

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BeamlineElement.ApertureType	ApertureType describes different types of apertures.

Constructor Summary

Constructors

Constructor	Description
BeamlineElement()

Method Summary

Modifier and Type	Method	Description
BeamlineElement.ApertureType	getApertureType()
Double	getApertureX()
Double	getApertureY()
CorrectionElement	getCorrectionElement()
Double	getLength()
Double	getOpticalLength()
Double	getPosition()
Collection<BeamlineElementPropertyValue>	getProperties()
void	setApertureType(BeamlineElement.ApertureType apertureType)
void	setApertureX(Double apertureX)
void	setApertureY(Double apertureY)
void	setCorrectionElement(CorrectionElement correctionElement)
void	setLength(Double length)
void	setOpticalLength(Double opticalLength)
void	setPosition(Double position)
void	setProperties(Collection<BeamlineElementPropertyValue> properties)

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

BeamlineElement

public BeamlineElement()

Method Details

getLength

public Double getLength()

setLength

public void setLength(Double length)

getPosition

public Double getPosition()

setPosition

public void setPosition(Double position)

getApertureY

public Double getApertureY()

setApertureY

public void setApertureY(Double apertureY)

getApertureX

public Double getApertureX()

setApertureX

public void setApertureX(Double apertureX)

setOpticalLength

public void setOpticalLength(Double opticalLength)

getOpticalLength

public Double getOpticalLength()

getApertureType

public BeamlineElement.ApertureType getApertureType()

setApertureType

public void setApertureType(BeamlineElement.ApertureType apertureType)

getCorrectionElement

public CorrectionElement getCorrectionElement()

setCorrectionElement

public void setCorrectionElement(CorrectionElement correctionElement)

getProperties

public Collection<BeamlineElementPropertyValue> getProperties()

setProperties

public void setProperties(Collection<BeamlineElementPropertyValue> properties)