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

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

All Implemented Interfaces:

IArchive

public class SynchronousState

extends ProbeState

Field Summary

protected static java.lang.String	ATTR_PHASEBETA attribute tag for betatron phase
protected static java.lang.String	ATTR_PHASERF attribute tag for RF phase
protected static java.lang.String	LABEL_SYNCH element tag for RF phase

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

STATE_LABEL

Constructor Summary

SynchronousState()
Default constructor.

SynchronousState(SynchronousProbe probe)
Copy constructor.

Method Summary

protected void	addPropertiesTo(DataAdaptor daptSink) Save the probe state values to a data store represented by the DataAdaptor interface.
R3	getBetatronPhase() Return the betatron phase advances in each plane.
double	getRfPhase() Return the phase location of the synchronous particle with respect to any driving RF power.
protected void	readPropertiesFrom(DataAdaptor daptSrc) Restore the state values for this probe state object from the data store represented by the DataAdaptor interface.
void	setBetatronPhase(R3 vecPhase) Set the betatron phase of the synchronous particle without space charge.
void	setRfPhase(double dblPhase) Set the phase location of the synchronous particle with respect to the drive RF power.
java.lang.String	toString() Return a textual representation of the ProbeState internal state.

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

LABEL_SYNCH

protected static final java.lang.String LABEL_SYNCH

element tag for RF phase

See Also:

Constant Field Values

ATTR_PHASEBETA

protected static final java.lang.String ATTR_PHASEBETA

attribute tag for betatron phase

See Also:

Constant Field Values

ATTR_PHASERF

protected static final java.lang.String ATTR_PHASERF

attribute tag for RF phase

See Also:

Constant Field Values

Constructor Detail

SynchronousState

public SynchronousState()

Default constructor. Create a new SynchronousState object with zero state values.

SynchronousState

public SynchronousState(SynchronousProbe probe)

Copy constructor. Create a new SynchronousState object and initialize the state to that of the specified probe argument.

Parameters:

probe - probe containing initializing state information

Method Detail

setBetatronPhase

public void setBetatronPhase(R3 vecPhase)

Set the betatron phase of the synchronous particle without space charge. The betatron phase of all three planes is maintained as an R3 vector object. Thus, the betatron phase of each plane is set simultaneously.

Parameters:

vecPhase - vector (psix,psiy,psiz) of betatron phases in radians

setRfPhase

public void setRfPhase(double dblPhase)

Set the phase location of the synchronous particle with respect to the drive RF power.

Parameters:

dblPhase - synchronous particle phase w.r.t. RF in radians

getBetatronPhase

public R3 getBetatronPhase()

Return the betatron phase advances in each plane.

Returns:

vector (psix,psiy,psiz) of betatron phases in radians

getRfPhase

public double getRfPhase()

Return the phase location of the synchronous particle with respect to any driving RF power.

Returns:

phase location of synchronous particle in radians

addPropertiesTo

protected void addPropertiesTo(DataAdaptor daptSink)

Save the probe state values to a data store represented by the DataAdaptor interface.

Overrides:

addPropertiesTo in class ProbeState

Parameters:

daptSink - data sink with DataAdaptor interface

See Also:

ProbeState.addPropertiesTo(gov.sns.tools.data.DataAdaptor)

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor daptSrc)
                           throws ParsingException

Restore the state values for this probe state object from the data store represented by the DataAdaptor interface.

Overrides:

readPropertiesFrom in class ProbeState

Parameters:

daptSrc - data source for probe state information

Throws:

ParsingException - error in data format

See Also:

ProbeState.readPropertiesFrom(gov.sns.tools.data.DataAdaptor)

toString

public java.lang.String toString()

Description copied from class: ProbeState

Return a textual representation of the ProbeState internal state.

Overrides:

toString in class ProbeState

Returns:

See Also:

Object.toString()