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

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

All Implemented Interfaces:

IArchive

public class ParticleProbeState

extends ProbeState

Encapsulates the state of a ParticleProbe at a particular point in time.

Field Summary

protected static java.lang.String	PARTICLE_LABEL element tag for particle data
protected static java.lang.String	X_LABEL
protected static java.lang.String	XP_LABEL
protected static java.lang.String	Y_LABEL
protected static java.lang.String	YP_LABEL
protected static java.lang.String	Z_LABEL
protected static java.lang.String	ZP_LABEL

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

STATE_LABEL

Constructor Summary

ParticleProbeState()
Default constructor.

ParticleProbeState(ParticleProbe probe)
Initializing constructor.

Method Summary

protected void	addPropertiesTo(DataAdaptor container) Save the state values particular to BeamProbeState objects to the data sink.
PhaseVector	phaseCoordinates() Returns homogeneous phase space coordinates of the particle.
protected void	readPropertiesFrom(DataAdaptor container) Recover the state values particular to BeamProbeState objects from the data source.
void	setPhaseCoordinates(PhaseVector vecPhase) Set the phase coordinates of the probe.
java.lang.String	toString() Write out the state information in text form.

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

Field Detail

PARTICLE_LABEL

protected static final java.lang.String PARTICLE_LABEL

element tag for particle data

See Also:

Constant Field Values

X_LABEL

protected static final java.lang.String X_LABEL

See Also:

Constant Field Values

Y_LABEL

protected static final java.lang.String Y_LABEL

See Also:

Constant Field Values

Z_LABEL

protected static final java.lang.String Z_LABEL

See Also:

Constant Field Values

XP_LABEL

protected static final java.lang.String XP_LABEL

See Also:

Constant Field Values

YP_LABEL

protected static final java.lang.String YP_LABEL

See Also:

Constant Field Values

ZP_LABEL

protected static final java.lang.String ZP_LABEL

See Also:

Constant Field Values

Constructor Detail

ParticleProbeState

public ParticleProbeState()

Default constructor. Creates a new, empty ParticleProbeState object.

ParticleProbeState

public ParticleProbeState(ParticleProbe probe)

Initializing constructor. Creates a new ParticleProbeState object and initialize it to the state of the probe argument.

Parameters:

probe - ParticleProbe containing initial state data

Method Detail

setPhaseCoordinates

public void setPhaseCoordinates(PhaseVector vecPhase)

Set the phase coordinates of the probe.

Parameters:

vecPhase - new homogeneous phase space coordinate vector

phaseCoordinates

public PhaseVector phaseCoordinates()

Returns homogeneous phase space coordinates of the particle. The units are meters and radians.

Returns:

vector (x,x',y,y',z,z',1) of phase space coordinates

toString

public java.lang.String toString()

Write out the state information in text form.

Overrides:

toString in class ProbeState

Returns:

internal state information as a String.

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

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

Overrides:

addPropertiesTo in class ProbeState

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

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

Overrides:

readPropertiesFrom in class ProbeState

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted