IProbe

All Known Implementing Classes:

BunchProbe, DiagnosticProbe, EnsembleProbe, EnvelopeProbe, ParticleProbe, Probe, SynchronousProbe, TransferMapProbe, TwissProbe
```
public interface IProbe
```
The root interface of physical objects and mathematical abstractions used in UAL applications (for example: Bunch, Particle, Twiss, Taylor map, and others). According to the Element-Algorithm-Probe analysis pattern, the Probe objects interact with accelerator structures, Element's. These interactions are implemented as the separate classes (Tracker, Mapper, etc.) that support the Algorithm interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`LightSpeed` Speed of light in vacuum (meters/second)
`static double`	`Permittivity` Electric permittivity of free space (Farad/meter)
`static double`	`UnitCharge` The unit electric charge (Farads)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IAlgorithm`	`getAlgorithm()` Return the dynamics algorithm associated with this probe.
`IArchive`	`getArchive()` Return the `IArchive` interface for archiving this algorithm object.
`double`	`getBeta()` Returns the probe velocity normalized to the speed of light.
`java.lang.String`	`getCurrentElement()` Returns the current lattice element of the probe.
`java.lang.String`	`getCurrentHardwareId()` Returns the identifier of the hardware being modeling by the current element.
`double`	`getGamma()` Returns the relativistic parameter corresponding to the probe velocity.
`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
`java.lang.String`	`getSpeciesName()` returns the species name
`double`	`getSpeciesRestEnergy()` Returns the rest energy of particle species
`double`	`getTime()` Return the time elapsed since the probe began propagation.
`void`	`initialize()` Initialize the probe for propagation.
`void`	`performPostProcessing()` Perform any required post processing upon completion of algorithm processing.
`void`	`setCurrentElement(java.lang.String id)` Set the current lattice element.
`void`	`setCurrentHardwareId(java.lang.String strSmfId)` Sets the string identifier of the hardware node modeled by the current element.
`void`	`setKineticEnergy(double dblW)` Set the current kinetic energy of the probe.
`void`	`setPosition(double dblPos)` Set the current position of the probe along the beamline.
`void`	`setSpeciesCharge(double dblQ)` Set the species charge.
`void`	`setSpeciesRestEnergy(double m)` Set the species rest energy.
`void`	`setTime(double dblTime)` Set the current time since the probe began propagating
`void`	`update()` Update all data and connections.

- Field Detail
  - LightSpeed
```
static final double LightSpeed
```
    Speed of light in vacuum (meters/second)
    
    See Also:
    
    Constant Field Values
  - UnitCharge
```
static final double UnitCharge
```
    The unit electric charge (Farads)
    
    See Also:
    
    Constant Field Values
  - Permittivity
```
static final double Permittivity
```
    Electric permittivity of free space (Farad/meter)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSpeciesName
```
java.lang.String getSpeciesName()
```
    returns the species name
    
    Returns:
    
    species name
  - getSpeciesCharge
```
double getSpeciesCharge()
```
    Returns the charge of probe's particle species
    
    Returns:
    
    particle species charge in units of positive electron charge
  - getSpeciesRestEnergy
```
double getSpeciesRestEnergy()
```
    Returns the rest energy of particle species
    
    Returns:
    
    particle species rest energy in electron volts
  - getCurrentElement
```
java.lang.String getCurrentElement()
```
    Returns the current lattice element of the probe.
    
    Returns:
    
    String id of current lattice element
  - getCurrentHardwareId
```
java.lang.String getCurrentHardwareId()
```
    Returns the identifier of the hardware being modeling by the current element.
    
    Returns:
    
    hardware ID of the current modeling element
    
    Since:
    
    Sep 3, 2014
  - getPosition
```
double getPosition()
```
    Returns the current beam-line position of the probe
    
    Returns:
    
    probe position (meters)
  - getTime
```
double getTime()
```
    Return the time elapsed since the probe began propagation.
    
    Returns:
    
    elapsed time 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)
  - getBeta
```
double getBeta()
```
    Returns the probe velocity normalized to the speed of light.
    
    Returns:
    
    normalized probe velocity v/c (unitless
  - getGamma
```
double getGamma()
```
    Returns the relativistic parameter corresponding to the probe velocity. The relativistic factor is given by the formulae gamma = (Kinetic Energy/Rest Energy) + 1 = sqrt[1/(1-v^2/c^2)]
    
    Returns:
    
    probe relatistic factor (unitless)
  - setCurrentElement
```
void setCurrentElement(java.lang.String id)
```
    Set the current lattice element.
    
    Parameters:
    
    id - String id of current lattice element.
  - setCurrentHardwareId
```
void setCurrentHardwareId(java.lang.String strSmfId)
```
    Sets the string identifier of the hardware node modeled by the current element.
    
    Parameters:
    
    strSmfId - hardware ID of the current modeling element
    
    Since:
    
    Sep 3, 2014
  - setPosition
```
void setPosition(double dblPos)
```
    Set the current position of the probe along the beamline.
    
    Parameters:
    
    dblPos - new probe position (meters)
  - setTime
```
void setTime(double dblTime)
```
    Set the current time since the probe began propagating
    
    Parameters:
    
    dblTime - new probe current time in seconds
  - setKineticEnergy
```
void setKineticEnergy(double dblW)
```
    Set the current kinetic energy of the probe.
    
    Parameters:
    
    dblW - new probe kinetic energy (electron-volts)
    
    See Also:
    
    getKineticEnergy()
  - setSpeciesCharge
```
void setSpeciesCharge(double dblQ)
```
    Set the species charge.
    
    Parameters:
    
    dblQ - new species charge (e.u.)
    
    See Also:
    
    getSpeciesCharge()
  - setSpeciesRestEnergy
```
void setSpeciesRestEnergy(double m)
```
    Set the species rest energy.
    
    Parameters:
    
    m - new species rest energy (eV)
    
    See Also:
    
    getSpeciesRestEnergy()
  - initialize
```
void initialize()
         throws ModelException
```
    Initialize the probe for propagation. Reset any necessary state variables Optionally set up a trajectory variable
    
    Throws:
    
    ModelException - an error occurred while trying to initialize the probe
  - update
```
void update()
     throws ModelException
```
    Update all data and connections. Recompute any parameters consistent with new probe state Optionally store probe state to save trajectory history Resynchronize probe with data sources if they exist
    
    Throws:
    
    ModelException - an error occurred while trying to update the probe
  - performPostProcessing
```
void performPostProcessing()
```
    Perform any required post processing upon completion of algorithm processing.
  - getAlgorithm
```
IAlgorithm getAlgorithm()
```
    Return the dynamics algorithm associated with this probe.
  - getArchive
```
IArchive getArchive()
```
    Return the IArchive interface for archiving this algorithm object.

Interface IProbe

Field Summary

Method Summary

Field Detail

LightSpeed

UnitCharge

Permittivity

Method Detail

getSpeciesName

getSpeciesCharge

getSpeciesRestEnergy

getCurrentElement

getCurrentHardwareId

getPosition

getTime

getKineticEnergy

getBeta

getGamma

setCurrentElement

setCurrentHardwareId

setPosition

setTime

setKineticEnergy

setSpeciesCharge

setSpeciesRestEnergy

initialize

update

performPostProcessing

getAlgorithm

getArchive