xal.model.elem

Class ThickElectromagnet

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.ThickElectromagnet

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

Direct Known Subclasses:

IdealMagQuad, IdealMagSectorDipole, IdealMagSectorDipole2, IdealMagSkewQuad3, IdealMagSolenoid, IdealPermMagQuad, ThickDipole

public abstract class ThickElectromagnet
extends ThickElement
implements IElectromagnet

This class implements IElectromagnet interface for thick magnets.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	dblField Field strength of the dipole magnet
protected int	enmOrient bending plane of dipole

Fields inherited from interface xal.model.elem.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
ThickElectromagnet(java.lang.String strType)
ThickElectromagnet(java.lang.String strType, java.lang.String strId)
ThickElectromagnet(java.lang.String strType, java.lang.String strId, double dblLen)

Method Summary

Modifier and Type	Method and Description
double	getMagField() Get the magnetic field strength of the electromagnet
int	getOrientation() Return the orientation enumeration code.
void	initializeFrom(LatticeElement latticeElement) Conversion method to be provided by the user
void	setMagField(double dblField) Set the magnetic field strength of the electromagnet.
void	setOrientation(int enmOrient) Set the dipole bending plane orientation

Methods inherited from class xal.model.elem.ThickElement

energyGain, getLength, setLength, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, elapsedTime, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setPosition, toString

Methods inherited from class java.lang.Object

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

Field Detail

enmOrient

protected int enmOrient

bending plane of dipole

dblField

protected double dblField

Field strength of the dipole magnet

Constructor Detail

ThickElectromagnet

public ThickElectromagnet(java.lang.String strType,
                          java.lang.String strId,
                          double dblLen)

ThickElectromagnet

public ThickElectromagnet(java.lang.String strType,
                          java.lang.String strId)

ThickElectromagnet

public ThickElectromagnet(java.lang.String strType)

Method Detail

getOrientation

public int getOrientation()

Return the orientation enumeration code. Return the orientation enumeration code for the bending plane of the associated dipole magnet / focusing plane of quadrupole.

Specified by:

getOrientation in interface IElectromagnet

Returns:

ORIENT_HOR - quadrupole focuses in x (horizontal) plane dipole has steering action in x (horizontal) plane ORIENT_VER - quadrupole focuses in y ( vertical ) plane dipole has steering action in y (vertical) plane ORIENT_NONE - error

getMagField

public double getMagField()

Get the magnetic field strength of the electromagnet

Specified by:

getMagField in interface IElectromagnet

Returns:

magnetic field (in Tesla/meter for quads, Tesla for dipoles).

setOrientation

public void setOrientation(int enmOrient)

Set the dipole bending plane orientation

Specified by:

setOrientation in interface IElectromagnet

Parameters:

enmOrient - magnet orientation enumeration code

See Also:

getOrientation()

setMagField

public void setMagField(double dblField)

Set the magnetic field strength of the electromagnet.

Specified by:

setMagField in interface IElectromagnet

Parameters:

dblField - magnetic field (in Tesla/meter for quads, Tesla for dipoles).

initializeFrom

public void initializeFrom(LatticeElement latticeElement)

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class ThickElement

Parameters:

latticeElement - the SMF node to convert