gov.sns.xal.model.probe
Class DiagnosticProbe

java.lang.Object
  |
  +--gov.sns.xal.model.probe.Probe
        |
        +--gov.sns.xal.model.probe.DiagnosticProbe

All Implemented Interfaces:

IArchive, IProbe

public class DiagnosticProbe

extends Probe

Simple diagnostic probe for testing the Lattice framework.

Field Summary

Fields inherited from class gov.sns.xal.model.probe.Probe

PROBE_LABEL

Fields inherited from interface gov.sns.xal.model.IProbe

LightSpeed, Permittivity, UnitCharge

Constructor Summary

DiagnosticProbe()
Default constructor for DiagnosticProbe.

Method Summary

void	applyState(ProbeState state) Apply the contents of ProbeState to update my current state.
ProbeState	createProbeState() Captures the probe's state in a ProbeState of the appropriate species.
Trajectory	createTrajectory() Require concrete implementations to override this method to create a Trajectory object of the appropriate species.
int	getElementsVisited()
void	incrementElementsVisited()
void	setElementsVisited(int n)

Methods inherited from class gov.sns.xal.model.probe.Probe

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, deepCopyProbeBase, getAlgorithm, getArchive, getBeta, getBetaGamma, getComment, getCurrentElement, getGamma, getKineticEnergy, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, load, newProbeInitializedFrom, readFrom, reset, save, setAlgorithm, setComment, setCurrentElement, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime, setTimestamp, setTracking, update

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticProbe

public DiagnosticProbe()

Default constructor for DiagnosticProbe. Creates a new (empty) instance of DiagnosticProbe.

Method Detail

getElementsVisited

public int getElementsVisited()

setElementsVisited

public void setElementsVisited(int n)

incrementElementsVisited

public void incrementElementsVisited()

createTrajectory

public Trajectory createTrajectory()

Description copied from class: Probe

Require concrete implementations to override this method to create a Trajectory object of the appropriate species.

Specified by:

createTrajectory in class Probe

Returns:

a Trajectory of the appropriate species for this probe type

createProbeState

public ProbeState createProbeState()

Description copied from class: Probe

Captures the probe's state in a ProbeState of the appropriate species.

Specified by:

createProbeState in class Probe

applyState

public void applyState(ProbeState state)

Description copied from class: Probe

Apply the contents of ProbeState to update my current state. Subclass implementations should call super.applyState to ensure superclass state is applied.

Overrides:

applyState in class Probe

Parameters:

state - ProbeState object containing new probe state data