Package xal.tools.beam.calc

Interface ISimulationResults

All Known Subinterfaces:

ISimulationResults.ISimEnvResults<S>, ISimulationResults.ISimLocResults<S>

All Known Implementing Classes:

CalculationsOnBeams, CalculationsOnMachines, CalculationsOnParticles, CalculationsOnRings, SimpleSimResultsAdaptor, SimResultsAdaptor

public interface ISimulationResults

Encapsulates base for any interfaces that processes simulation data. Interfaces expose particle, machine, and beam parameters derived from the state data produced by numerical simulation. The context of these quantities should depend upon the type S of the probe states produced by the simulation.

Probe types can expose multiple interfaces. In particular, for S = xal.model.probe.traj.TransferMapState the quantities of this interface can be regarded as machine parameters, since the beam does not influence transfer map calculations in the xal.model.probe.TransferMapProbe. However, a there are particle processors and envelope processors for them. The results of the calculations must be taken in the context of the data upon which they calculate. See the associated Javadoc.

Since:

Nov 15, 2013

Author:

Christopher K. Allen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ISimulationResults.ISimEnvResults<S>	Processes simulation data concerned with the beam properties.
static interface	ISimulationResults.ISimLocResults<S>	This interface defines methods for computation results that are in the form of points, or locations, in phase space.