xal.model.probe.traj

Class SynchronousState

java.lang.Object

xal.model.probe.traj.ProbeState<SynchronousState>

xal.model.probe.traj.SynchronousState

All Implemented Interfaces:

IProbeState, IArchive

public class SynchronousState
extends ProbeState<SynchronousState>

Field Summary

Fields

Modifier and Type	Field and Description
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 xal.model.probe.traj.ProbeState

STATE_LABEL, TYPE_LABEL

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

LightSpeed

Constructor Summary

Constructors

Constructor and Description
SynchronousState() Default constructor.
SynchronousState(SynchronousProbe probe) Copy constructor.
SynchronousState(SynchronousState stateSync) Copy constructor for SynchronousState.

Method Summary

Modifier and Type	Method and Description
protected void	addPropertiesTo(DataAdaptor daptSink) Save the probe state values to a data store represented by the DataAdaptor interface.
SynchronousState	copy() Implements the clone operation required by the base class ProbeState
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() Returns a string representation of this particle state.

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

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, 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(SynchronousState stateSync)

Copy constructor for SynchronousState. Initializes the new SynchronousState objects with the state attributes of the given SynchronousState.

Parameters:

stateSync - initializing state

Since:

Jun 26, 2014

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

copy

public SynchronousState copy()

Implements the clone operation required by the base class ProbeState

Specified by:

copy in class ProbeState<SynchronousState>

Returns:

a deep copy of this object.

Since:

Jun 27, 2014

See Also:

ProbeState.copy()

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<SynchronousState>

Parameters:

daptState - data sink to receive state information

See Also:

gov.sns.xal.model.probe.traj.ProbeState#addPropertiesTo(gov.DataAdaptor.tools.data.IDataAdaptor)

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<SynchronousState>

Parameters:

daptSrc - data source for probe state information

Throws:

ParsingException - error in data format

See Also:

gov.sns.xal.model.probe.traj.ProbeState#readPropertiesFrom(gov.DataAdaptor.tools.data.IDataAdaptor)

toString

public java.lang.String toString()

Returns a string representation of this particle state. Currently returns only the super class implementation.

Overrides:

toString in class ProbeState<SynchronousState>

Returns:

the value super.toString()

See Also:

Object.toString()