Package xal.model.elem

Class IdealMagOctupole

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.IdealMagOctupole

All Implemented Interfaces:

IComponent, IElement

public class IdealMagOctupole
extends ThinElement

Octupole magnets element Created by Hiroyuki Sako on 11/30/07.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	type string identifier for all octupole elements

Fields inherited from class xal.model.elem.Element

dblNodeLen, dblNodePos

Fields inherited from interface xal.model.IElement

LIGHT_SPEED, PERMEABILITY, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
IdealMagOctupole()	Constructor
IdealMagOctupole(String strId)	Constructor

Method Summary

Modifier and Type	Method	Description
double	elapsedTime(IProbe probe)	Returns the time taken for the probe to propagate through element.
double	energyGain(IProbe probe)	Returns energy gain which is zero.
protected PhaseMap	transferMap(IProbe probe)	Returns the transfer map of this element which is the identity.

Methods inherited from class xal.model.elem.ThinElement

applyErrors, elapsedTime, energyGain, getLength, longitudinalPhaseAdvance, longitudinalPhaseAdvance, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getLatticePosition, getNodeLen, getNodePos, getParent, getPhiX, getPhiY, getPhiZ, getPosition, getType, getUID, initializeFrom, print, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setParent, setPhiX, setPhiY, setPhiZ, setPosition, toString

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

type string identifier for all octupole elements

See Also:

• Constant Field Values

Constructor Details

IdealMagOctupole

public IdealMagOctupole(String strId)

Constructor

Parameters:

strId - identifier of this object

IdealMagOctupole

public IdealMagOctupole()

Constructor

Method Details

elapsedTime

public double elapsedTime(IProbe probe)

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

Specified by:

elapsedTime in class ThinElement

Parameters:

probe - propagating probe

Returns:

the value zero

energyGain

public double energyGain(IProbe probe)

Returns energy gain which is zero.

Specified by:

energyGain in class ThinElement

Parameters:

probe - dummy argument

Returns:

returns zero

transferMap

protected PhaseMap transferMap(IProbe probe)
                        throws PropagationException

Returns the transfer map of this element which is the identity.

Specified by:

transferMap in class ThinElement

Parameters:

probe - dummy argument

Returns:

the identity phase map

Throws:

PropagationException - this should not occur