ProbeState

java.lang.Object
- xal.model.probe.traj.ProbeState<S>

All Implemented Interfaces:

IProbeState, IArchive

Direct Known Subclasses:

BunchProbeState, DiagnosticProbeState, ParticleProbeState, SynchronousState, TransferMapState
```
public abstract class ProbeState<S extends ProbeState<S>>
extends java.lang.Object
implements IProbeState
```
Stores a snapshot of a probes state at a particular instant in time. Concrete extensions to this class should be developed for each type of probe.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`STATE_LABEL` element tag for the probe state data
`protected static java.lang.String`	`TYPE_LABEL` attribute tag for concrete type of probe state

Fields inherited from interface xal.model.probe.traj.IProbeState
LightSpeed

Constructor Summary

Constructors
Constructor and Description
`ProbeState()` Default constructor - creates an empty `ProbeState` object.
`ProbeState(Probe<S> probe)` Initializing Constructor.
`ProbeState(S state)` Copy constructor for ProbeState.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPropertiesTo(DataAdaptor container)` Save the state information to a `DataAdaptor` interface.
`protected double`	`computeBetaFromGamma(double gamma)` Convenience function for computing the probe's velocity beta (w.r.t.
`protected double`	`computeGammaFromBeta(double beta)` Computes the relatavistic factor gamma from the current beta value
`protected double`	`computeGammaFromW(double W)` Convenience function for computing the relatistic factor gamma from the probe's kinetic energy (using the particle species rest energy m_dblParEr).
`abstract S`	`copy()` Creates a new clone of this object.
`double`	`getBeta()` Returns the probe velocity normalized to the speed of light.
`protected double`	`getBetaGamma()` Convenience function for multiplication of beta * gamma
`java.lang.String`	`getElementId()` Returns the id of the lattice element associated with this state.
`double`	`getGamma()` Return the relativistic gamma of the probe.
`java.lang.String`	`getHardwareNodeId()` Returns the identifier of the hardware node modeled by the associated modeling element for this state.
`double`	`getKineticEnergy()` Return the kinetic energy of the probe.
`double`	`getMomentum()` Returns the momentum
`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`	`load(DataAdaptor container)` Recovers the state information from a data source represented by a `DataAdaptor` interface.
`protected void`	`readPropertiesFrom(DataAdaptor container)` Recover the state information from a `DataAdaptor` interface.
`void`	`save(DataAdaptor daSink)` Save the state information to a data sink represented by a `DataAdaptor` interface
`void`	`setElementId(java.lang.String id)` Set the lattice element id associated with this state.
`void`	`setHardwareNodeId(java.lang.String strSmfId)` Sets the hardware node ID modeled by the element owning 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.
`java.lang.String`	`toString()` Return a textual representation of the `ProbeState` internal state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATE_LABEL
```
public static final java.lang.String STATE_LABEL
```
    element tag for the probe state data
    
    See Also:
    
    Constant Field Values
  - TYPE_LABEL
```
protected static final java.lang.String TYPE_LABEL
```
    attribute tag for concrete type of probe state
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProbeState
```
public ProbeState()
```
    Default constructor - creates an empty ProbeState object.
  - ProbeState
```
public ProbeState(S state)
```
    Copy constructor for ProbeState. Initializes the new ProbeState objects with the state attributes of the given probe state.
    
    Parameters:
    
    state - initializing state
    
    Since:
    
    Jun 26, 2014
  - ProbeState
```
public ProbeState(Probe<S> probe)
```
    Initializing Constructor. Creates a ProbeState object initialized to the state of the Probe argument.
    
    Parameters:
    
    probe - Probe object containing initial values
- Method Detail
  - copy
```
public abstract S copy()
```
    Creates a new clone of this object.
    
    Returns:
    
    a deep copy of this object.
    
    Since:
    
    Jun 26, 2014
  - setSpeciesCharge
```
public void setSpeciesCharge(double q)
```
    Set the charge of the particle species in the beam
    
    Specified by:
    
    setSpeciesCharge in interface IProbeState
    
    Parameters:
    
    q - species particle charge (Coulombs)
  - setSpeciesRestEnergy
```
public void setSpeciesRestEnergy(double Er)
```
    Set the rest energy of a single particle in the beam
    
    Specified by:
    
    setSpeciesRestEnergy in interface IProbeState
    
    Parameters:
    
    Er - particle rest energy (electron-volts)
  - setPosition
```
public void setPosition(double s)
```
    Set the current position of the probe along the beamline.
    
    Specified by:
    
    setPosition in interface IProbeState
    
    Parameters:
    
    s - new probe position (meters)
    
    See Also:
    
    getPosition()
  - setTime
```
public void setTime(double dblTime)
```
    Set the current probe time elapsed from the start of the probe tracking.
    
    Specified by:
    
    setTime in interface IProbeState
    
    Parameters:
    
    dblTime - elapsed time in seconds
  - setKineticEnergy
```
public void setKineticEnergy(double W)
```
    Set the current kinetic energy of the probe.
    
    Specified by:
    
    setKineticEnergy in interface IProbeState
    
    Parameters:
    
    W - new probe kinetic energy (electron-volts)
    
    See Also:
    
    getKineticEnergy()
  - setElementId
```
public void setElementId(java.lang.String id)
```
    Set the lattice element id associated with this state.
    
    Specified by:
    
    setElementId in interface IProbeState
    
    Parameters:
    
    id - element id of current lattice element
  - setHardwareNodeId
```
public void setHardwareNodeId(java.lang.String strSmfId)
```
    Sets the hardware node ID modeled by the element owning this state.
    
    Parameters:
    
    strSmfId - hardware ID of the state
    
    Since:
    
    Sep 3, 2014
  - getSpeciesCharge
```
public double getSpeciesCharge()
```
    Returns the charge of probe's particle species
    
    Specified by:
    
    getSpeciesCharge in interface IProbeState
    
    Returns:
    
    particle species charge (Coulombs)
  - getSpeciesRestEnergy
```
public double getSpeciesRestEnergy()
```
    Returns the rest energy of particle species
    
    Specified by:
    
    getSpeciesRestEnergy in interface IProbeState
    
    Returns:
    
    particle species rest energy (electron-volts)
  - getMomentum
```
public double getMomentum()
```
    Returns the momentum
    
    Returns:
    
    particle momentum
  - getElementId
```
public java.lang.String getElementId()
```
    Returns the id of the lattice element associated with this state.
    
    Specified by:
    
    getElementId in interface IProbeState
    
    Returns:
    
    string ID of associated lattice element
  - getHardwareNodeId
```
public java.lang.String getHardwareNodeId()
```
    Returns the identifier of the hardware node modeled by the associated modeling element for this state.
    
    Returns:
    
    hardware ID of this state's modeling element
    
    Since:
    
    Sep 3, 2014
  - getPosition
```
public double getPosition()
```
    Returns the current beam-line position of the probe
    
    Specified by:
    
    getPosition in interface IProbeState
    
    Returns:
    
    probe position (meters)
  - getTime
```
public double getTime()
```
    Return the time elapsed from the start of the probe tracking
    
    Specified by:
    
    getTime in interface IProbeState
    
    Returns:
    
    time elapsed since probe began tracking, in seconds
  - getKineticEnergy
```
public 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.
    
    Specified by:
    
    getKineticEnergy in interface IProbeState
    
    Returns:
    
    probe kinetic energy (electron-volts)
  - getBeta
```
public double getBeta()
```
    Returns the probe velocity normalized to the speed of light.
    
    Returns:
    
    normalized probe velocity v/c (unitless
  - getGamma
```
public double getGamma()
```
    Return the relativistic gamma of the probe. Depending upon the probe type, this could be the actual gamma of a single constituent particle, the average gamma of an ensemble, the design gamma, etc.
    
    Returns:
    
    probe kinetic energy (electron-volts)
  - toString
```
public java.lang.String toString()
```
    Return a textual representation of the ProbeState internal state.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string containing current ProbeState state
  - save
```
public final void save(DataAdaptor daSink)
```
    Save the state information to a data sink represented by a DataAdaptor interface
    
    Specified by:
    
    save in interface IArchive
    
    Parameters:
    
    daSink - data source to receive state information
  - load
```
public final void load(DataAdaptor container)
                throws DataFormatException
```
    Recovers the state information from a data source represented by a DataAdaptor interface.
    
    Specified by:
    
    load in interface IArchive
    
    Parameters:
    
    container - data source containing state information
    
    Throws:
    
    DataFormatException - data in container is malformated
  - computeGammaFromBeta
```
protected double computeGammaFromBeta(double beta)
```
    Computes the relatavistic factor gamma from the current beta value
    
    Parameters:
    
    beta - speed of probe w.r.t. the speed of light
    
    Returns:
    
    relatavistic factor gamma
  - computeGammaFromW
```
protected double computeGammaFromW(double W)
```
    Convenience function for computing the relatistic factor gamma from the probe's kinetic energy (using the particle species rest energy m_dblParEr).
    
    Parameters:
    
    W - kinetic energy of the probe
    
    Returns:
    
    relatavistic factor gamma
  - computeBetaFromGamma
```
protected double computeBetaFromGamma(double gamma)
```
    Convenience function for computing the probe's velocity beta (w.r.t. the speed of light) from the relatistic factor gamma.
    
    Parameters:
    
    beta - relatavistic factor gamma
    
    Returns:
    
    speed of probe (w.r.t. speed of light)
  - getBetaGamma
```
protected double getBetaGamma()
```
    Convenience function for multiplication of beta * gamma
  - addPropertiesTo
```
protected void addPropertiesTo(DataAdaptor container)
```
    Save the state information to a DataAdaptor interface.
    
    Parameters:
    
    container - data sink with DataAdaptor interface
  - readPropertiesFrom
```
protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException
```
    Recover the state information from a DataAdaptor interface.
    
    Parameters:
    
    container - data source with DataAdaptor interface
    
    Throws:
    
    ParsingException - data source is malformatted

Class ProbeState<S extends ProbeState<S>>

Field Summary

Fields inherited from interface xal.model.probe.traj.IProbeState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_LABEL

TYPE_LABEL

Constructor Detail

ProbeState

ProbeState

ProbeState

Method Detail

copy

setSpeciesCharge

setSpeciesRestEnergy

setPosition

setTime

setKineticEnergy

setElementId

setHardwareNodeId

getSpeciesCharge

getSpeciesRestEnergy

getMomentum

getElementId

getHardwareNodeId

getPosition

getTime

getKineticEnergy

getBeta

getGamma

toString

save

load

computeGammaFromBeta

computeGammaFromW

computeBetaFromGamma

getBetaGamma

addPropertiesTo

readPropertiesFrom