gov.sns.xal.model.probe.traj
Class EnsembleProbeState

java.lang.Object
  |
  +--gov.sns.xal.model.probe.traj.ProbeState
        |
        +--gov.sns.xal.model.probe.traj.BeamProbeState
              |
              +--gov.sns.xal.model.probe.traj.EnsembleProbeState

All Implemented Interfaces:

IArchive

public class EnsembleProbeState

extends BeamProbeState

Encapsulates the state of an EnsembleProbe at a particular point in time.

Field Summary

Fields inherited from class gov.sns.xal.model.probe.traj.ProbeState

STATE_LABEL

Constructor Summary

EnsembleProbeState()
Default constructor.

EnsembleProbeState(EnsembleProbe probe)
Initializing Constructor.

Method Summary

protected void	addPropertiesTo(DataAdaptor container) Save the state values particular to EnsembleProbeState objects to the data sink.
Ensemble	getEnsemble() Return the Ensemble state object
int	getFieldCalculation() Return the field calculation method
CorrelationMatrix	phaseCorrelation() Return the correlation matrix of the distribution
protected void	readPropertiesFrom(DataAdaptor container) Recover the state values particular to EnsembleProbeState objects from the data source.
void	setEnsemble(Ensemble ens) Set the state to the value of the argument NOTE: the copy operation can be expansive for large Ensembles
void	setFieldCalculation(int fc) Set the field calculation method
java.lang.String	toString() Write out state information to a string.

Methods inherited from class gov.sns.xal.model.probe.traj.BeamProbeState

getBeamCharge, getBeamCurrent, phaseCovariance, phaseMean, rmsEmittances, setBeamCharge, setBeamCurrent, twissParameters

Methods inherited from class gov.sns.xal.model.probe.traj.ProbeState

getElementId, getKineticEnergy, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, readFrom, save, setElementId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

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

Constructor Detail

EnsembleProbeState

public EnsembleProbeState()

Default constructor. Create a new, empty EnsembleProbeState object.

EnsembleProbeState

public EnsembleProbeState(EnsembleProbe probe)

Initializing Constructor. Create a new EnsembleProbeState object and initialize it to the state of the probe argument.

Parameters:

probe - EnsembleProbe containing initializing state information

Method Detail

setFieldCalculation

public void setFieldCalculation(int fc)

Set the field calculation method

setEnsemble

public void setEnsemble(Ensemble ens)

Set the state to the value of the argument NOTE: the copy operation can be expansive for large Ensembles

Parameters:

ens - Ensemble object to be copied

getFieldCalculation

public int getFieldCalculation()

Return the field calculation method

getEnsemble

public Ensemble getEnsemble()

Return the Ensemble state object

phaseCorrelation

public CorrelationMatrix phaseCorrelation()

Return the correlation matrix of the distribution

Specified by:

phaseCorrelation in class BeamProbeState

Returns:

symmetric 7x7 covariance matrix in homogeneous coordinates

See Also:

CorrelationMatrix

toString

public java.lang.String toString()

Write out state information to a string.

Overrides:

toString in class BeamProbeState

Returns:

text version of internal state data

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

Save the state values particular to EnsembleProbeState objects to the data sink.

Overrides:

addPropertiesTo in class BeamProbeState

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

Recover the state values particular to EnsembleProbeState objects from the data source.

Overrides:

readPropertiesFrom in class BeamProbeState

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted