xal.model.elem

Class Collimator

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.Collimator

All Implemented Interfaces:

IComponent, IElement

public class Collimator
extends ThinElement

This class is used as a location marker in the modeling lattice. Is has no length and no effect on the dynamics of any probe.

Field Summary

Fields

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

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
Collimator() JavaBean constructor - creates a new uninitialized instance of Marker BE CAREFUL
Collimator(java.lang.String strId) Creates a new instance of Marker

Method Summary

Modifier and Type	Method and 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

elapsedTime, energyGain, getLength, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, initializeFrom, 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 Marker objects

See Also:

Constant Field Values

Constructor Detail

Collimator

public Collimator(java.lang.String strId)

Creates a new instance of Marker

Parameters:

strId - identifier of this object

Collimator

public Collimator()

JavaBean constructor - creates a new uninitialized instance of Marker BE CAREFUL

Method Detail

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