xal.model.elem

Class IdealMagSextupole

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThickElement

xal.model.elem.IdealMagSextupole

All Implemented Interfaces:

IComponent, IElement

public class IdealMagSextupole
extends ThickElement

Sextupole magnets element

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType type string identifier for all sextople elements

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
IdealMagSextupole() Constructor
IdealMagSextupole(java.lang.String strID, double length) Constructor

Method Summary

Modifier and Type	Method and Description
double	elapsedTime(IProbe probe, double length) Determine the time taken for the probe to propagate through element.
double	energyGain(IProbe probe, double length) Determine energy gain which is zero.
PhaseMap	transferMap(IProbe probe, double length) Determine the transfer map of this element which is simply treated as a drift.

Methods inherited from class xal.model.elem.ThickElement

getLength, initializeFrom, setLength

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

s_strType

public static final java.lang.String s_strType

type string identifier for all sextople elements

See Also:

Constant Field Values

Constructor Detail

IdealMagSextupole

public IdealMagSextupole(java.lang.String strID,
                         double length)

Constructor

Parameters:

strID - identifier of this object

length - magnetic length of the magnet

IdealMagSextupole

public IdealMagSextupole()

Constructor

Method Detail

elapsedTime

public double elapsedTime(IProbe probe,
                          double length)

Determine the time taken for the probe to propagate through element.

Specified by:

elapsedTime in interface IElement

Specified by:

elapsedTime in class Element

Parameters:

probe - probe at the entrance to this element

length - of the magnet

Returns:

the value zero

energyGain

public double energyGain(IProbe probe,
                         double length)

Determine energy gain which is zero.

Specified by:

energyGain in interface IElement

Specified by:

energyGain in class ThickElement

Parameters:

probe - probe at the entrance to this element

length - of the magnet

Returns:

returns zero

transferMap

public PhaseMap transferMap(IProbe probe,
                            double length)
                     throws PropagationException

Determine the transfer map of this element which is simply treated as a drift.

Specified by:

transferMap in interface IElement

Specified by:

transferMap in class ThickElement

Parameters:

probe - probe at the entrance to this element

length - of the magnet

Returns:

transfer map

Throws:

PropagationException - this should not occur

See Also:

IElement.transferMap(IProbe,double)