Uses of Interface
xal.tools.data.IArchive

Packages that use IArchive

Package	Description
xal.extension.jels.model.alg
xal.extension.jels.model.elem	Combination of modeling elements from TraceWin documentation put into OpenXAL reference frame.
xal.extension.jels.model.probe
xal.model	The Online Model
xal.model.alg
xal.model.probe
xal.model.probe.traj
xal.tools.beam	Contains classes for representing particle beams and various aspects and properties of particle beams.
xal.tools.math
xal.tools.math.r2	Package contains tools for working in the space of real number pairs (x,y) ∈ R2.
xal.tools.math.r3
xal.tools.math.r4
xal.tools.math.r6
xal.tools.math.rn	Package for doing linear algebra in the general base space of Rn where n is a positive integer.

Uses of IArchive in xal.extension.jels.model.alg

Classes in xal.extension.jels.model.alg that implement IArchive

Modifier and Type	Class	Description
class	ElsTracker	Propagation of probe as implemented in ELS.

Uses of IArchive in xal.extension.jels.model.elem

Classes in xal.extension.jels.model.elem that implement IArchive

Modifier and Type	Class	Description
class	FieldMapIntegrator	General electromagnetic field map integrator.

Uses of IArchive in xal.extension.jels.model.probe

Classes in xal.extension.jels.model.probe that implement IArchive

Modifier and Type	Class	Description
class	ElsProbe	This is a probe ported from ELS implementation.

Uses of IArchive in xal.model

Subinterfaces of IArchive in xal.model

Modifier and Type	Interface	Description
interface	IAlgorithm	The defining interface of all probe tracking algorithms

Methods in xal.model that return IArchive

Modifier and Type	Method	Description
IArchive	IProbe.getArchive()	Return the IArchive interface for archiving this algorithm object.

Uses of IArchive in xal.model.alg

Classes in xal.model.alg that implement IArchive

Modifier and Type	Class	Description
class	DiagnosticTracker	Simple algorithm for testing the model framework.
class	EnsembleTracker	Implements the tracking mechanism for EnsembleProbe objects.
class	EnvelopeBacktracker	Tracking algorithm for EnvelopeProbe objects.
class	EnvelopeTracker	Tracking algorithm for propagating EnvelopeProbe objects.
class	EnvelopeTrackerBase	Abstract Base Class for Algorithms Propagating RMS Envelopes
class	EnvelopeTrackerPmq	This class is a super class of the EnvelopeTracker class meant to handle the special case of IdealPermMagQuad elements.
class	EnvelopeTrackerPmqDipole	This class is a super class of the EnvelopeTracker class meant to handle the special case of IdealPermMagQuad elements.
class	EnvTrackerAdapt	Tracking algorithm for EnvelopeProbe's.
class	ParticleTracker	Algorithm for tracking a single particle, represented by the class ParticleProbe through a XAL modeling element, represented by an object exposing the IComponent interface.
class	SynchronousTracker	Algorithm for propagating a SynchronousProbe object through any modeling element that exposes the IComponent interface.
class	Trace3dTracker	Tracking algorithm for EnvelopeProbe's.
class	Tracker	Abstract Base Class for Tracking Algorithms
class	TrackerAdaptive	Deprecated. functionality pushed down into child class class EnvTrackerAdapt
class	TransferMapTracker	Propagates a TransferMapPropbe through a hardware element.
class	TwissTracker	Tracking algorithm for TwissProbe objects.
class	TwissTrackerPmq	This class is a super class of the TwissTracker class meant to handle the special case of IdealPermMagQuad elements.

Uses of IArchive in xal.model.probe

Classes in xal.model.probe that implement IArchive

Modifier and Type	Class	Description
class	BunchProbe<S extends BunchProbeState<S>>	Abstract base class for all probes having beam properties.
class	DiagnosticProbe	Simple diagnostic probe for testing the Lattice framework.
class	EnsembleProbe	Represents an ensemble of particles.
class	EnvelopeProbe	EnvelopeProbe represents the RMS beam envelopes of a beam.
class	ParticleProbe	ParticleProbe extends the base BeamProbe to manage a particle state which is a Vector of homogeneous phase space variables.
class	Probe<S extends ProbeState<S>>	Provides a base class implementation of the IProbe interface that is useful for most standard probe types.
class	SynchronousProbe	This class represents the behavior of the synchronous particle of a particle beam bunch.
class	TransferMapProbe	Probe that tracks all the transfer maps between modeling elements.
class	TwissProbe	EnvelopeProbe represents the RMS beam envelopes of a beam.

Methods in xal.model.probe that return IArchive

Modifier and Type	Method	Description
IArchive	Probe.getArchive()	Return the archiving interface for this object.

Uses of IArchive in xal.model.probe.traj

Subinterfaces of IArchive in xal.model.probe.traj

Modifier and Type	Interface	Description
interface	IProbeState	The interface required of all classes encapsulating the state data of probes.

Classes in xal.model.probe.traj that implement IArchive

Modifier and Type	Class	Description
class	BunchProbeState<S extends BunchProbeState<S>>	Encapsulates a BunchProbe's state at a point in time.
class	DiagnosticProbeState	Encapsulates the state of a DiagnosticProbe at a particular point in time.
class	EnsembleProbeState	Encapsulates the state of an EnsembleProbe at a particular point in time.
class	EnvelopeProbeState	Encapsulates the state of an EnvelopeProbe at a particular point in time.
class	ParticleProbeState	Encapsulates the state of a ParticleProbe at a particular point in time.
class	ProbeState<S extends ProbeState<S>>	Stores a snapshot of a probes state at a particular instant in time.
class	SynchronousState
class	Trajectory<S extends ProbeState<S>>	Manages the history for a probe.
class	TransferMapState	Probe state for the transfer map tracker.
class	TwissProbeState	Saves the state of a TwissProbe at a particular instance.

Uses of IArchive in xal.tools.beam

Classes in xal.tools.beam that implement IArchive

Modifier and Type	Class	Description
class	CovarianceMatrix	A CovarianceMatrix in homogeneous coordinates represents all moments of a phase space distribution up to and including second order.
class	EnergyVector	Class encapsulating the synchronous phase coordinates.
class	PhaseMap	Represents a generalized map between homogeneous phase space coordinates.
class	PhaseMatrix	Represents a two-tensor on the space of homogeneous phase space coordinates in three spatial dimensions.
class	PhaseVector	Class .
class	Twiss3D	Class .

Uses of IArchive in xal.tools.math

Classes in xal.tools.math that implement IArchive

Modifier and Type	Class	Description
class	BaseMatrix<M extends BaseMatrix<M>>	Class BaseMatrix.
class	BaseVector<V extends BaseVector<V>>	Class Vector is the abstract base class for matrix objects supported in the XAL tools packages.
class	GenericMatrix	Concrete implementation of a BaseMatrix class for general matrices.
class	GenericSquareMatrix	Concrete implementation of Square matrix of arbitrary size
class	GenericVector	Concrete implementation of vector with arbitrary length.
class	SquareMatrix<M extends SquareMatrix<M>>	Class SquareMatrix is the abstract base class for square matrix objects supported in the XAL tools packages.

Uses of IArchive in xal.tools.math.r2

Classes in xal.tools.math.r2 that implement IArchive

Modifier and Type	Class	Description
class	R2x2	Represents an element of R2x2, the set of real 3x3 matrices.

Uses of IArchive in xal.tools.math.r3

Classes in xal.tools.math.r3 that implement IArchive

Modifier and Type	Class	Description
class	R3	Represents an element of R^3, the three-dimensional cartesian real space.
class	R3x3	Represents an element of R3×3, the set of real, 3×3 matrices.

Uses of IArchive in xal.tools.math.r4

Classes in xal.tools.math.r4 that implement IArchive

Modifier and Type	Class	Description
class	R4	Implements the set of real 4-vectors in R4
class	R4x4	Represents an element of R4×4, the set of real, 4×4 matrices.

Uses of IArchive in xal.tools.math.r6

Classes in xal.tools.math.r6 that implement IArchive

Modifier and Type	Class	Description
class	R6	Implements a 6-dimensional vector of real numbers.
class	R6x6	Represents an element of R6×6, the set of real, 6×6 matrices.

Uses of IArchive in xal.tools.math.rn

Classes in xal.tools.math.rn that implement IArchive

Modifier and Type	Class	Description
class	Rmxn	Real matrix with arbitrary row and column dimensions.
class	Rn	Represents a vector of real numbers with arbitrary length.