xal.model.probe.traj

Interface IProbeState

All Superinterfaces:

IArchive

All Known Implementing Classes:

BunchProbeState, DiagnosticProbeState, EnsembleProbeState, EnvelopeProbeState, ParticleProbeState, ProbeState, SynchronousState, TransferMapState, TwissProbeState

public interface IProbeState
extends IArchive

The interface required of all classes encapsulating the state data of probes.

Since:

Apr 14, 2011

Field Summary

Fields

Modifier and Type	Field and Description
static double	LightSpeed Speed of light in vacuum (meters/second)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementId() Returns the id of the lattice element associated with this state.
double	getKineticEnergy() Return the kinetic energy of the probe.
double	getPosition() Returns the current beam-line position of the probe
double	getSpeciesCharge() Returns the charge of probe's particle species
double	getSpeciesRestEnergy() Returns the rest energy of particle species
double	getTime() Return the time elapsed from the start of the probe tracking
void	setElementId(java.lang.String id) Set the lattice element id associated with this state.
void	setKineticEnergy(double W) Set the current kinetic energy of the probe.
void	setPosition(double s) Set the current position of the probe along the beamline.
void	setSpeciesCharge(double q) Set the charge of the particle species in the beam
void	setSpeciesRestEnergy(double Er) Set the rest energy of a single particle in the beam
void	setTime(double dblTime) Set the current probe time elapsed from the start of the probe tracking.

Methods inherited from interface xal.tools.data.IArchive

load, save

Field Detail

LightSpeed

static final double LightSpeed

Speed of light in vacuum (meters/second)

See Also:

Constant Field Values

Method Detail

setSpeciesCharge

void setSpeciesCharge(double q)

Set the charge of the particle species in the beam

Parameters:

q - species particle charge (Coulombs)

setSpeciesRestEnergy

void setSpeciesRestEnergy(double Er)

Set the rest energy of a single particle in the beam

Parameters:

Er - particle rest energy (electron-volts)

setPosition

void setPosition(double s)

Set the current position of the probe along the beamline.

Parameters:

s - new probe position (meters)

See Also:

getPosition()

setTime

void setTime(double dblTime)

Set the current probe time elapsed from the start of the probe tracking.

Parameters:

dblTime - elapsed time in seconds

setKineticEnergy

void setKineticEnergy(double W)

Set the current kinetic energy of the probe.

Parameters:

W - new probe kinetic energy (electron-volts)

See Also:

getKineticEnergy()

setElementId

void setElementId(java.lang.String id)

Set the lattice element id associated with this state.

Parameters:

id - element id of current lattice element

getSpeciesCharge

double getSpeciesCharge()

Returns the charge of probe's particle species

Returns:

particle species charge (Coulombs)

getSpeciesRestEnergy

double getSpeciesRestEnergy()

Returns the rest energy of particle species

Returns:

particle species rest energy (electron-volts)

getElementId

java.lang.String getElementId()

Returns the id of the lattice element associated with this state.

Returns:

string ID of associated lattice element

getPosition

double getPosition()

Returns the current beam-line position of the probe

Returns:

probe position (meters)

getTime

double getTime()

Return the time elapsed from the start of the probe tracking

Returns:

time elapsed since probe began tracking, in seconds

getKineticEnergy

double getKineticEnergy()

Return the kinetic energy of the probe. Depending upon the probe type, this could be the actual kinetic energy of a single constituent particle, the average kinetic energy of an ensemble, the design energy, etc.

Returns:

probe kinetic energy (electron-volts)