Package xal.model.probe

Class SynchronousProbe

java.lang.Object

xal.model.probe.Probe<S>

xal.model.probe.BunchProbe<SynchronousState>

xal.model.probe.SynchronousProbe

All Implemented Interfaces:

IProbe, IArchive

public class SynchronousProbe
extends BunchProbe<SynchronousState>

This class represents the behavior of the synchronous particle of a particle beam bunch. Thus, its use is intended for evaluation of machine designs and the variation of design trajectories with respect to machine parameters.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@ess.eu>

Field Summary

Fields inherited from class xal.model.probe.Probe

COMMENT_LABEL, PROBE_LABEL, stateCurrent, TEXT_LABEL, TIME_LABEL, trajHist, TYPE_LABEL

Fields inherited from interface xal.model.IProbe

LIGHT_SPEED, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
SynchronousProbe()
SynchronousProbe(SynchronousProbe probe)

Method Summary

Modifier and Type	Method	Description
SynchronousProbe	copy()	Creates a deep copy of the probe
SynchronousState	createEmptyProbeState()	Creates a new, empty SynchronousState.
SynchronousState	createProbeState()	Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.
Trajectory<SynchronousState>	createTrajectory()	Creates a Trajectory<SynchronousState> object of the proper type for saving the probe's history.
double	getEnergyGain()	Return the energy gain in the current element.
double	getSynchronousPhase()	Return the synchronous phase.
protected SynchronousState	readStateFrom(DataAdaptor container)	Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.
void	setEnergyGain(double dblEnergyGain)	Set the energy gain for the current element.
void	setSynchronousPhase(double dblPhase)	Set the synchronous phase.

Methods inherited from class xal.model.probe.BunchProbe

beamDCPerveance, beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency

Methods inherited from class xal.model.probe.Probe

applyState, cloneCurrentProbeState, deepCopy, getAlgorithm, getArchive, getBeta, getComment, getCurrentElement, getCurrentElementTypeId, getCurrentHardwareId, getCurrentState, getGamma, getInitialState, getKineticEnergy, getLongitinalPhase, getMomentum, getPosition, getSpeciesCharge, getSpeciesName, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, initializeFrom, load, lookupLastStateFor, newProbeInitializedFrom, performPostProcessing, readFrom, reset, save, setAlgorithm, setComment, setCurrentElement, setCurrentElementTypeId, setCurrentHardwareId, setKineticEnergy, setLongitudinalPhase, setPosition, setSpeciesCharge, setSpeciesName, setSpeciesRestEnergy, setTime, setTimestamp, setTracking, update

Methods inherited from class java.lang.Object

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

Constructor Details

SynchronousProbe

public SynchronousProbe()

SynchronousProbe

public SynchronousProbe(SynchronousProbe probe)

Parameters:

probe -

Method Details

copy

public SynchronousProbe copy()

Description copied from class: Probe

Creates a deep copy of the probe

Specified by:

copy in class Probe<SynchronousState>

setSynchronousPhase

public void setSynchronousPhase(double dblPhase)

Set the synchronous phase.

Parameters:

dblPhase - synchronous phase in radians

getSynchronousPhase

public double getSynchronousPhase()

Return the synchronous phase.

Returns:

synchronous phase in radians

setEnergyGain

public void setEnergyGain(double dblEnergyGain)

Set the energy gain for the current element.

Parameters:

dblEnergyGain - energy gain in eV

getEnergyGain

public double getEnergyGain()

Return the energy gain in the current element.

Returns:

energy gain in eV

createTrajectory

public Trajectory<SynchronousState> createTrajectory()

Creates a Trajectory<SynchronousState> object of the proper type for saving the probe's history.

Specified by:

createTrajectory in class Probe<SynchronousState>

Returns:

a new, empty Trajectory<SynchronousState> for saving the probe's history

createProbeState

public SynchronousState createProbeState()

Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.

Specified by:

createProbeState in class BunchProbe<SynchronousState>

Returns:

probe state object of type SynchronousState

See Also:

• Probe.createProbeState()

createEmptyProbeState

public SynchronousState createEmptyProbeState()

Creates a new, empty SynchronousState.

Specified by:

createEmptyProbeState in class BunchProbe<SynchronousState>

Returns:

a new, empty SynchronousState

readStateFrom

protected SynchronousState readStateFrom(DataAdaptor container)
                                  throws DataFormatException

Description copied from class: Probe

Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.

Specified by:

readStateFrom in class Probe<SynchronousState>

Parameters:

container - DataAdaptor to read a Trajectory from

Returns:

a ProbeState for the contents of the DataAdaptor

Throws:

DataFormatException - error encountered reading the DataAdaptor