Package xal.model.alg

Class ParticleTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.ParticleTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class ParticleTracker
extends Tracker

Algorithm for tracking a single particle, represented by the class ParticleProbe through a XAL modeling element, represented by an object exposing the IComponent interface.

Author:

Christopher K. Allen, Craig McChesney

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<ParticleProbe>	CLS_PROBE_TYPE	probe type recognized by this algorithm
static final String	TYPE_ID	string type identifier for this algorithm
static final int	VERSION	current version of this algorithm

Fields inherited from class xal.model.alg.Tracker

ATTRTAG_DEBUG, ATTRTAG_RFGAP_PHASE, ATTRTAG_TYPE, ATTRTAG_UPDATE, ATTRTAG_VER, NODETAG_ALG, NODETAG_TRACKER, TBL_LBL_ALGORITHM, TBL_PRIM_KEY_NAME, UPDATE_ALWAYS, UPDATE_CUSTOM, UPDATE_ENTRANCE, UPDATE_ENTRANCEANDEXIT, UPDATE_EXIT

Constructor Summary

Constructors

Constructor	Description
ParticleTracker()	Creates a new instance of ParticleTracker
ParticleTracker(ParticleTracker sourceTracker)	Copy constructor for ParticleTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(ParticleProbe probe, IElement elem, double dblLen)	Advances the probe state through the element.
ParticleTracker	copy()	Create a deep copy of ParticleTracker
void	doPropagation(IProbe iProbe, IElement elem)	Propagates the probe through the element.

Methods inherited from class xal.model.alg.Tracker

advanceProbe, getDebugMode, getElemPosition, getProbeType, getProbeUpdatePolicy, getRfGapPhaseCalculation, getStartElementId, getStopElementId, getType, getVersion, initialize, isStopElementIncluded, load, load, newFromEditContext, newFromEditContext, newInstance, propagate, registerProbeType, retractProbe, save, setDebugMode, setElemPosition, setIncludeStopElement, setProbeUpdatePolicy, setRfGapPhaseCalculation, setStartElementId, setStopElementId, unsetStartElementId, unsetStopElementId, validElement, validProbe

Methods inherited from class java.lang.Object

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

Field Details

TYPE_ID

public static final String TYPE_ID

string type identifier for this algorithm

VERSION

public static final int VERSION

current version of this algorithm

See Also:

• Constant Field Values

CLS_PROBE_TYPE

public static final Class<ParticleProbe> CLS_PROBE_TYPE

probe type recognized by this algorithm

Constructor Details

ParticleTracker

public ParticleTracker()

Creates a new instance of ParticleTracker

ParticleTracker

public ParticleTracker(ParticleTracker sourceTracker)

Copy constructor for ParticleTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public ParticleTracker copy()

Create a deep copy of ParticleTracker

doPropagation

public void doPropagation(IProbe iProbe,
 IElement elem)
                   throws ModelException

Propagates the probe through the element.

Specified by:

doPropagation in class Tracker

Parameters:

iProbe - probe to propagate

elem - element acting on probe

Throws:

ModelException - invalid probe type or error in advancing probe

See Also:

• Tracker.validProbe(IProbe)

advanceState

protected void advanceState(ParticleProbe probe,
 IElement elem,
 double dblLen)
                     throws ModelException

Advances the probe state through the element.

Parameters:

probe - probe being modified

elem - element acting on probe

dblLen - length of element to advance

Throws:

ModelException - bad element transfer matrix/corrupt probe state