public class TransferMapState extends ProbeState<TransferMapState>
Probe state for the transfer map tracker.
ICoordinateState
requires the methods
@link ICoordinateState#getPhaseCoordinates()}
etc.
Interface ICoordinateState
extends IProbeState
.
Well, TransferMapState
inherits from ProbeState
which implements IProbeState
. It's getting dicey.
TransferMapState
is really meant to compute
transfer maps only, and be very light weight. If you want to compute
closed orbit maps we should make a different probe.
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ATTR_MAP
attribute tag for betatron phase
|
protected static java.lang.String |
LABEL_STATE
element tag for RF phase
|
STATE_LABEL, TYPE_LABEL
LightSpeed
Constructor and Description |
---|
TransferMapState()
Constructor, create new
TransferMapState and
initialize to zero state values. |
TransferMapState(TransferMapProbe probe)
Initializing constructor - create a new
TransferMapState object and initialize it to the current state of the given probe. |
TransferMapState(TransferMapState transferMapState)
Copy constructor for TransferMapState.
|
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. |
TransferMapState |
copy()
Implements the clone operation required by the base class
ProbeState . |
PhaseMap |
getPartialTransferMap()
Returns the partial transfer map that transports particle
phase coordinates through the space occupied by this state.
|
PhaseMap |
getTransferMap()
Get the composite transfer map at this state location.
|
protected void |
readPropertiesFrom(DataAdaptor daptSrc)
Restore the state values for this probe state object from the data store
represented by the
DataAdaptor interface. |
void |
setPartialTransferMap(PhaseMap mapPart)
Sets the current partial transfer map, or "through map".
|
void |
setStateTransferMap(PhaseMap mapTrans)
Set the transfer map across this state, from entrance to exit.
|
void |
setTransferMap(PhaseMap mapTrans)
Set the current composite transfer map up to the current probe location.
|
java.lang.String |
toString()
Get a string representation of this state.
|
computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime
protected static final java.lang.String LABEL_STATE
protected static final java.lang.String ATTR_MAP
public TransferMapState()
TransferMapState
and
initialize to zero state values.public TransferMapState(TransferMapState transferMapState)
TransferMapState
objects with the state attributes
of the given TransferMapState
.transferMapState
- initializing statepublic TransferMapState(TransferMapProbe probe)
TransferMapState
object and initialize it to the current state of the given probe.probe
- probe object with initial state informationpublic void setTransferMap(PhaseMap mapTrans)
mapTrans
- transfer map in homogeneous phase coordinatesProbe.createTrajectory()
public void setPartialTransferMap(PhaseMap mapPart)
mapPart
- transfer map through this statepublic void setStateTransferMap(PhaseMap mapTrans)
mapTrans
- transfer map in homogeneous phase coordinatesProbe.createTrajectory()
public PhaseMap getTransferMap()
TransferMapTrajectory
parent (i.e., at the first state of the trajectory object)
to this state.public PhaseMap getPartialTransferMap()
Returns the partial transfer map that transports particle phase coordinates through the space occupied by this state.
Get the partial transfer map that maps particle phase coordinates from
the previous state exit to this state's exit. The product of all these
partial transfer maps from the first state to this state would yield
the returned value of
.
getTransferMap()
public TransferMapState copy()
ProbeState
.copy
in class ProbeState<TransferMapState>
ProbeState.copy()
protected void addPropertiesTo(DataAdaptor daptSink)
DataAdaptor
interface.addPropertiesTo
in class ProbeState<TransferMapState>
daptSink
- data sink to receive state informationgov.sns.xal.model.probe.traj.ProbeState#addPropertiesTo(gov.DataAdaptor.tools.data.IDataAdaptor)
protected void readPropertiesFrom(DataAdaptor daptSrc) throws ParsingException
DataAdaptor
interface.readPropertiesFrom
in class ProbeState<TransferMapState>
daptSrc
- data source for probe state informationParsingException
- error in data formatgov.sns.xal.model.probe.traj.ProbeState#readPropertiesFrom(gov.DataAdaptor.tools.data.IDataAdaptor)
public java.lang.String toString()
toString
in class ProbeState<TransferMapState>
Object.toString()