xal.model.alg

Class ParticleTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.ParticleTracker

All Implemented Interfaces:

java.rmi.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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<ParticleProbe>	s_clsProbeType probe type recognized by this algorithm
static int	s_intVersion current version of this algorithm
static java.lang.String	s_strTypeId string type identifier for 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_PRIM_KEY_NAME, UPDATE_ALWAYS, UPDATE_CUSTOM, UPDATE_ENTRANCE, UPDATE_ENTRANCEANDEXIT, UPDATE_EXIT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
void	load(DataAdaptor daSource) Place holder for loading additional parameters from a data adaptor.
void	load(java.lang.String strPrimKeyVal, EditContext ecTableData) Place holder for loading additional parameters from an edit context.
void	save(DataAdaptor daptArchive) Place holder for loading additional parameters from a data adaptor.

Methods inherited from class xal.model.alg.Tracker

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

Methods inherited from class java.lang.Object

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

Field Detail

s_strTypeId

public static final java.lang.String s_strTypeId

string type identifier for this algorithm

s_intVersion

public static final int s_intVersion

current version of this algorithm

See Also:

Constant Field Values

s_clsProbeType

public static final java.lang.Class<ParticleProbe> s_clsProbeType

probe type recognized by this algorithm

Constructor Detail

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 Detail

copy

public ParticleTracker copy()

Create a deep copy of ParticleTracker

load

public void load(java.lang.String strPrimKeyVal,
                 EditContext ecTableData)
          throws DataFormatException

Place holder for loading additional parameters from an edit context.

Specified by:

load in interface IContextAware

Overrides:

load in class Tracker

Parameters:

strPrimKeyVal - primary key value specifying the name of the data record

ecTableData - EditContext containing table data

Throws:

DataFormatException - bad data format - error in reading

Since:

Oct 26, 2012

See Also:

Tracker.load(java.lang.String, xal.tools.data.EditContext)

load

public void load(DataAdaptor daSource)
          throws DataFormatException

Place holder for loading additional parameters from a data adaptor.

Specified by:

load in interface IArchive

Overrides:

load in class Tracker

Parameters:

daSource - data source containing algorithm configuration

Throws:

DataFormatException - bad format in algorithm data

Since:

Oct 26, 2012

See Also:

Tracker.load(xal.tools.data.DataAdaptor)

save

public void save(DataAdaptor daptArchive)

Place holder for loading additional parameters from a data adaptor.

Specified by:

save in interface IArchive

Overrides:

save in class Tracker

Parameters:

daptArchive - data source to receive algorithm configuration

Since:

Oct 26, 2012

See Also:

Tracker.save(xal.tools.data.DataAdaptor)

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