Package xal.model.alg

Class EnsembleTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.EnsembleTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class EnsembleTracker
extends Tracker

Implements the tracking mechanism for EnsembleProbe objects. TODO not finished!

Author:

Christopher Allen, Craig McChesney

Field Summary

Fields

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

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
EnsembleTracker()	Creates a new instance of EnsembleTracker
EnsembleTracker(EnsembleTracker sourceTracker)	Copy constructor for EnsembleTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(IProbe probe, IElement elem, double dblLen)
protected int	compStepCount(IElement elem)	Returns the number of subsections to break the specified element in to for propagation.
EnsembleTracker	copy()	Create a deep copy of EnsembleTracker
void	doPropagation(IProbe probe, 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 algorithm

VERSION

public static final int VERSION

current algorithm version

See Also:

• Constant Field Values

CLS_PROBE_TYPE

public static final Class<EnsembleProbe> CLS_PROBE_TYPE

probe type recognized by this algorithm

Constructor Details

EnsembleTracker

public EnsembleTracker()

Creates a new instance of EnsembleTracker

EnsembleTracker

public EnsembleTracker(EnsembleTracker sourceTracker)

Copy constructor for EnsembleTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public EnsembleTracker copy()

Create a deep copy of EnsembleTracker

doPropagation

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

Propagates the probe through the element.

Specified by:

doPropagation in class Tracker

Parameters:

probe - probe to propagate

elem - element acting on probe

Throws:

ModelException - invalid probe type or error in advancing probe

See Also:

• Tracker.validProbe(IProbe)

compStepCount

protected int compStepCount(IElement elem)

Returns the number of subsections to break the specified element in to for propagation. Currently returns the ceiling of the element length divided by the space charge interval. This should be re-evaluated when the ensemble algorithm is fleshed out.

Parameters:

elem - Element currently acting on probe

Returns:

ceiling of element length divided by space charge interval

advanceState

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

Throws:

ModelException