xal.model.alg

Class SynchronousTracker

java.lang.Object

xal.model.alg.Tracker

xal.model.alg.SynchronousTracker

All Implemented Interfaces:

java.rmi.Remote, IAlgorithm, IArchive, IContextAware

public class SynchronousTracker
extends Tracker

Algorithm for propagating a SynchronousParticle probe object through any modeling element that exposes the IComponent interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<SynchronousProbe>	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
SynchronousTracker() Default constructor for a SynchronousTracker objects.
SynchronousTracker(SynchronousTracker sourceTracker) Copy constructor for SynchronousTracker

Method Summary

Modifier and Type	Method and Description
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	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<SynchronousProbe> s_clsProbeType

probe type recognized by this algorithm

Constructor Detail

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 Detail

copy

public SynchronousTracker copy()

Creates a deep copy of SynchronousTracker

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 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:

gov.sns.xal.model.alg.Tracker#doPropagation(gov.sns.xal.model.IProbe, gov.sns.xal.model.IElement)