gov.sns.xal.model.probe
Class ParticleProbe

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

All Implemented Interfaces:

IArchive, IProbe

public class ParticleProbe

extends Probe

ParticleProbe extends the base BeamProbe to manage a particle state which is a Vector of homogeneous phase space variables.

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

ParticleProbe()
Default constructor for ParticleProbe.

ParticleProbe(ParticleProbe probe)
Copy constructor for ParticleProbe.

Method Summary

void	applyState(ProbeState state) Capture the current probe state to the ProbeState argument.
ProbeState	createProbeState() Captures the probe's state and return it as a new ProbeState object.
Trajectory	createTrajectory() Creates a new Trajectory object for ParticleProbe types.
PhaseVector	phaseCoordinates() Returns homogeneous phase space coordinates of the particle.
void	setPhaseCoordinates(PhaseVector vecPhase) Set the phase coordinates of the probe.

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

ParticleProbe

public ParticleProbe()

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

ParticleProbe

public ParticleProbe(ParticleProbe probe)

Copy constructor for ParticleProbe. Performs deep copy of target particle probe.

Parameters:

probe - ParticleProbe object to be cloned

Method Detail

phaseCoordinates

public PhaseVector phaseCoordinates()

Returns homogeneous phase space coordinates of the particle. The units are meters and radians.

Returns:

vector (x,x',y,y',z,z',1) of phase space coordinates

setPhaseCoordinates

public void setPhaseCoordinates(PhaseVector vecPhase)

Set the phase coordinates of the probe.

Parameters:

vecPhase - new homogeneous phase space coordinate vector

createTrajectory

public Trajectory createTrajectory()

Creates a new Trajectory object for ParticleProbe types.

Specified by:

createTrajectory in class Probe

Returns:

new, empty ParticleTrajectory object

createProbeState

public ProbeState createProbeState()

Captures the probe's state and return it as a new ProbeState object.

Specified by:

createProbeState in class Probe

Returns:

new ParticleProbeState object initialized to current state

applyState

public void applyState(ProbeState state)

Capture the current probe state to the ProbeState argument. Note that the argument must be of the concrete type ParticleProbeState.

Overrides:

applyState in class Probe

Parameters:

state - ProbeState to recieve this probe's state information

Throws:

java.lang.IllegalArgumentException - argument is not of type ParticleProbeState