xal.model.elem

Class ThinElectromagnet

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.ThinElectromagnet

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

Direct Known Subclasses:

IdealMagDipoleFace, IdealMagDipoleFace2, IdealMagFringeQuadFace, IdealMagSteeringDipole

public abstract class ThinElectromagnet
extends ThinElement
implements IElectromagnet

This class implements IElectromagnet interface for thin 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
ThinElectromagnet(java.lang.String strType)
ThinElectromagnet(java.lang.String strType, java.lang.String strId)

Method Summary

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

Methods inherited from class xal.model.elem.ThinElement

elapsedTime, elapsedTime, energyGain, energyGain, getLength, transferMap, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, 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

ThinElectromagnet

public ThinElectromagnet(java.lang.String strType)

ThinElectromagnet

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

Method Detail

getOrientation

public int getOrientation()

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

Specified by:

getOrientation in interface IElectromagnet

Returns:

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

getMagField

public double getMagField()

Get the magnetic field strength of the associated dipole

Specified by:

getMagField in interface IElectromagnet

Returns:

magnetic field (in Tesla).

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 dipole electromagnet.

Specified by:

setMagField in interface IElectromagnet

Parameters:

dblField - magnetic field (in Tesla).

initializeFrom

public void initializeFrom(LatticeElement latticeElement)

Conversion method to be provided by the user

Specified by:

initializeFrom in interface IComponent

Overrides:

initializeFrom in class Element

Parameters:

latticeElement - the SMF node to convert