gov.sns.xal.model.alg.resp
Class ParticleResponse

java.lang.Object
  |
  +--gov.sns.xal.model.alg.Tracker
        |
        +--gov.sns.xal.model.alg.resp.ParticleResponse

All Implemented Interfaces:

IAlgorithm, IArchive, java.rmi.Remote

public class ParticleResponse

extends Tracker

Field Summary

static java.lang.Class	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 gov.sns.xal.model.alg.Tracker

ATTRTAG_DEBUG, ATTRTAG_TYPE, ATTRTAG_UPDATE, ATTRTAG_VER, CALC_RFGAP_PHASE, NODETAG_ALG, NODETAG_TRACKER, NODETAG_TRAJ, UPDATE_ALWAYS, UPDATE_CUSTOM, UPDATE_ENTRANCE, UPDATE_ENTRANCEANDEXIT, UPDATE_EXIT

Constructor Summary

ParticleResponse()
Creates a new instance of ParticleTracker

Method Summary

protected void	advanceState(IProbe ifcProbe, IElement ifcElem, double dblLen) Advances the probe state through the element.
protected int	compStepCount(IElement elem) Returns the number of subsections to break the specified element into for propagation.
void	doPropagation(IProbe probe, IElement elem) Propagates the probe through the element.

Methods inherited from class gov.sns.xal.model.alg.Tracker

advanceProbe, getArchive, getDebugMode, getElemPosition, getProbeUpdatePolicy, getStartElementId, getStopElementId, getType, getVersion, initialize, load, propagate, registerProbeType, save, setDebugMode, setElemPosition, setProbeUpdatePolicy, 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

See Also:

Constant Field Values

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 s_clsProbeType

probe type recognized by this algorithm

Constructor Detail

ParticleResponse

public ParticleResponse()

Creates a new instance of ParticleTracker

Method Detail

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.advanceProbe(gov.sns.xal.model.IProbe, gov.sns.xal.model.IElement, double), Tracker.validProbe(gov.sns.xal.model.IProbe)

compStepCount

protected int compStepCount(IElement elem)

Returns the number of subsections to break the specified element into for propagation. Always one for a particle response.

Parameters:

elem - Element currently acting on probe

Returns:

one

advanceState

protected void advanceState(IProbe ifcProbe,
                            IElement ifcElem,
                            double dblLen)
                     throws ModelException

Advances the probe state through the element. Always advances the full length of the element, so the length parameter is ignored.

Parameters:

ifcProbe - interface to probe being modified

ifcElem - interface to element acting on probe

dblLen - element subsection lengh, ignored

Throws:

ModelException - bad element transfer matrix/corrupt probe state