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

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

All Implemented Interfaces:

IArchive

public class TransferMapState

extends ProbeState

Field Summary

protected static java.lang.String	ATTR_MAP attribute tag for betatron phase
protected static java.lang.String	LABEL_STATE element tag for RF phase

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

STATE_LABEL

Constructor Summary

TransferMapState()
Default 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.

Method Summary

protected void	addPropertiesTo(DataAdaptor daptSink) Save the probe state values to a data store represented by the DataAdaptor interface.
PhaseMap	getTransferMap() Get the composite transfer map for the current probe 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	setTransferMap(PhaseMap mapTrans) Set the current composite transfer map up to the current probe location.
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_STATE

protected static final java.lang.String LABEL_STATE

element tag for RF phase

See Also:

Constant Field Values

ATTR_MAP

protected static final java.lang.String ATTR_MAP

attribute tag for betatron phase

See Also:

Constant Field Values

Constructor Detail

TransferMapState

public TransferMapState()

Default constructor - create new TransferMapState and initialize to zero state values.

TransferMapState

public TransferMapState(TransferMapProbe probe)

Initializing constructor - create a new TransferMapState object and initialize it to the current state of the given probe.

Parameters:

probe - probe object with initial state information

Method Detail

setTransferMap

public void setTransferMap(PhaseMap mapTrans)

Set the current composite transfer map up to the current probe location.

Parameters:

mapTrans - transfer map in homogeneous phase coordinates

See Also:

Probe.createTrajectory()

getTransferMap

public PhaseMap getTransferMap()

Get the composite transfer map for the current probe location.

Returns:

transfer map in homogeneous phase space coordinates

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 to receive state information

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()