Package xal.model.alg

Class TransferMapTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.TransferMapTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class TransferMapTracker
extends Tracker

Propagates a TransferMapPropbe through a hardware element. This algorithm does not consider space charge, as that is an artifact of the beam, whereas the true transfer matrix is dependent upon the hardware only. The transfer maps of each hardware section are multiplied and then added to the probe's history.

Since:

2002

Author:

Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<TransferMapProbe>	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
TransferMapTracker()	Default constructor for a TransferMapTracker objects.
TransferMapTracker(TransferMapTracker sourceTracker)	Copy constructor for TransferMapTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(TransferMapProbe probe, IElement ifcElem, double dblLng)	Advances the probe state through the element.
TransferMapTracker	copy()	Creates a deep copy of TransferMapTracker
void	doPropagation(IProbe ifcProbe, IElement elem)	Perform the actual probe propagation through the the modeling 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

CLS_PROBE_TYPE

public static final Class<TransferMapProbe> CLS_PROBE_TYPE

probe type recognized by this algorithm

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

Constructor Details

TransferMapTracker

public TransferMapTracker()

Default constructor for a TransferMapTracker objects. These objects have no internal state information.

TransferMapTracker

public TransferMapTracker(TransferMapTracker sourceTracker)

Copy constructor for TransferMapTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public TransferMapTracker copy()

Creates a deep copy of TransferMapTracker

doPropagation

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

Perform the actual probe propagation through the the modeling element.

Specified by:

doPropagation in class Tracker

Parameters:

ifcProbe - interface to TransferMapProbe to be advanced

elem - interface to modeling element through which to advance probe

Throws:

ModelException - error during propagation

See Also:

• Tracker.doPropagation(xal.model.IProbe, xal.model.IElement)

advanceState

protected void advanceState(TransferMapProbe probe,
 IElement ifcElem,
 double dblLng)
                     throws ModelException

Advances the probe state through the element.

Parameters:

probe - interface to probe being modified

ifcElem - interface to element acting on probe

dblLng - element length

Throws:

ModelException - bad element transfer matrix/corrupt probe state