Package xal.model.alg

Class DiagnosticTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.DiagnosticTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class DiagnosticTracker
extends Tracker

Simple algorithm for testing the model framework.

Version:

$id:

Author:

Craig McChesney

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<DiagnosticProbe>	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
DiagnosticTracker()	Creates a new instance of ParticleTracker
DiagnosticTracker(DiagnosticTracker sourceTracker)	Copy constructor for DiagnosticTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(IProbe probe, IElement elem, double dblLen)	Advance the supplied probe through a subsection of the specified length in the specified element.
protected int	compStepCount(IElement elem)	Returns the number of sections to break the specified element in to for propagation.
DiagnosticTracker	copy()	Create a deep copy of DiagnosticTracker
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 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<DiagnosticProbe> CLS_PROBE_TYPE

probe type recognized by this algorithm

Constructor Details

DiagnosticTracker

public DiagnosticTracker()

Creates a new instance of ParticleTracker

DiagnosticTracker

public DiagnosticTracker(DiagnosticTracker sourceTracker)

Copy constructor for DiagnosticTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public DiagnosticTracker copy()

Create a deep copy of DiagnosticTracker

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 sections to break the specified element in to for propagation. Always one for a diagnostic probe.

Parameters:

elem - Element currently acting on probe

Returns:

one

advanceState

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

Advance the supplied probe through a subsection of the specified length in the specified element.

Parameters:

probe - Probe being acted on by element

elem - Element acting on probe

dblLen - length of element subsection to advance probe through