Package xal.model.probe.traj

Class DiagnosticProbeState

java.lang.Object

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

xal.model.probe.traj.DiagnosticProbeState

All Implemented Interfaces:

IProbeState, IArchive

public class DiagnosticProbeState
extends ProbeState<DiagnosticProbeState>

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

Version:

June 26, 2014

Author:

Craig McChesney, Christopher K. Allen

Field Summary

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

STATE_LABEL, TYPE_LABEL

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

LIGHT_SPEED

Constructor Summary

Constructors

Constructor	Description
DiagnosticProbeState()	Creates a new DiagnosticProbeState.
DiagnosticProbeState(DiagnosticProbe probe)	Creates a new DiagnosticProbeState with the state initialized from the given DiagnosticProbe.
DiagnosticProbeState(DiagnosticProbeState diagnosticProbeState)	Copy constructor for DiagnosticProbeState.

Method Summary

Modifier and Type	Method	Description
protected void	addPropertiesTo(DataAdaptor container)	Save the state information to a DataAdaptor interface.
DiagnosticProbeState	copy()	Implements the clone operation required by the base class ProbeState.
int	getElementsVisited()	Returns the number of elements traversed by probe at this state.
void	incrementElementsVisited()	Increments the number of element traversed by 1.
protected void	readPropertiesFrom(DataAdaptor container)	Recover the state information from a DataAdaptor interface.
void	setElementsVisited(int n)	Set the element count to the given number.
String	toString()	Returns a representation of the internal state as a string.

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

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getElementTypeId, getGamma, getHardwareNodeId, getKineticEnergy, getLongitudinalPhase, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setElementTypeId, setHardwareNodeId, setKineticEnergy, setLongitudinalPhase, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DiagnosticProbeState

public DiagnosticProbeState()

Creates a new DiagnosticProbeState.

Since:

Apr 19, 2011

DiagnosticProbeState

public DiagnosticProbeState(DiagnosticProbeState diagnosticProbeState)

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

Parameters:

diagnosticProbeState - initializing state

Since:

Jun 26, 2014

DiagnosticProbeState

public DiagnosticProbeState(DiagnosticProbe probe)

Creates a new DiagnosticProbeState with the state initialized from the given DiagnosticProbe.

Since:

Apr 19, 2011

Method Details

getElementsVisited

public int getElementsVisited()

Returns the number of elements traversed by probe at this state.

Returns:

number of model elements propagated by probe

Since:

Apr 19, 2011

setElementsVisited

public void setElementsVisited(int n)

Set the element count to the given number.

Parameters:

n - new value for the element traversed accumulator

Since:

Apr 19, 2011

incrementElementsVisited

public void incrementElementsVisited()

Increments the number of element traversed by 1.

Since:

Apr 19, 2011

copy

public DiagnosticProbeState copy()

Implements the clone operation required by the base class ProbeState.

Specified by:

copy in class ProbeState<DiagnosticProbeState>

Returns:

a deep copy of this object.

Since:

Jun 26, 2014

See Also:

• ProbeState.copy()

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

Description copied from class: ProbeState

Save the state information to a DataAdaptor interface.

Overrides:

addPropertiesTo in class ProbeState<DiagnosticProbeState>

Parameters:

container - data sink with DataAdaptor interface

Since:

Jun 27, 2014

See Also:

• ProbeState.addPropertiesTo(xal.tools.data.DataAdaptor)

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws DataFormatException

Description copied from class: ProbeState

Recover the state information from a DataAdaptor interface.

Overrides:

readPropertiesFrom in class ProbeState<DiagnosticProbeState>

Parameters:

container - data source with DataAdaptor interface

Throws:

DataFormatException - data source is malformatted

Since:

Jun 27, 2014

See Also:

• ProbeState.readPropertiesFrom(xal.tools.data.DataAdaptor)

toString

public String toString()

Returns a representation of the internal state as a string.

Overrides:

toString in class ProbeState<DiagnosticProbeState>

Returns:

string containing current ProbeState state

Since:

Jun 27, 2014

See Also:

• ProbeState.toString()