Package xal.model.alg

Class SynchronousTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.SynchronousTracker

All Implemented Interfaces:

Remote, IAlgorithm, IArchive, IContextAware

public class SynchronousTracker
extends Tracker

Algorithm for propagating a SynchronousProbe object through any modeling element that exposes the IComponent interface. It computes the synchronous phase at each cavity and cavity gaps, as well as the energy gain.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@ess.eu>

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<SynchronousProbe>	CLS_PROBE_TYPE
static final String	TYPE_ID
static final int	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
SynchronousTracker()	Default constructor for a SynchronousTracker objects.
SynchronousTracker(SynchronousTracker sourceTracker)	Copy constructor for SynchronousTracker

Method Summary

Modifier and Type	Method	Description
protected void	advanceState(IProbe ifcProbe, IElement elem)
SynchronousTracker	copy()	Creates a deep copy of SynchronousTracker
void	doPropagation(IProbe probe, IElement elem)	Perform the actual probe propagation through the the modeling element.
void	propagate(IProbe probe, IComponent elem)	This method was included to deal with RfCavitie objects

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

VERSION

public static final int VERSION

See Also:

• Constant Field Values

CLS_PROBE_TYPE

public static final Class<SynchronousProbe> CLS_PROBE_TYPE

Constructor Details

SynchronousTracker

public SynchronousTracker()

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

SynchronousTracker

public SynchronousTracker(SynchronousTracker sourceTracker)

Copy constructor for SynchronousTracker

Parameters:

sourceTracker - Tracker that is being copied

Method Details

copy

public SynchronousTracker copy()

Creates a deep copy of SynchronousTracker

doPropagation

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

Perform the actual probe propagation through the the modeling element.

Specified by:

doPropagation in class Tracker

Parameters:

probe - interface to SynchronousProbe 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)

propagate

public void propagate(IProbe probe,
 IComponent elem)
               throws ModelException

This method was included to deal with RfCavitie objects

Parameters:

probe -

elem -

Throws:

ModelException

advanceState

protected void advanceState(IProbe ifcProbe,
 IElement elem)