Package cern.accsoft.steering.jmad.domain.result.track

Interface DynapResultRequest

All Known Implementing Classes:

DynapResultRequestImpl

public interface DynapResultRequest

Defines the information wanted in the DynapResult

Method Summary

Modifier and Type	Method	Description
java.lang.Double[]	getApertureLimitation()
double	getLyapunov()
RelativeParticleDistribution	getRelativeParticleDistribution()
java.lang.Integer	getTurns()
boolean	isApertureLimited()
boolean	isFastTune()
boolean	isOrbit()
void	setApertureLimitation(double x, double px, double y, double py, double t, double pt)	Particles reaching these values are considered lost if this.isApertureLimited()
void	setApertureLimited(boolean apertureLimited)
void	setFastTune(boolean fastTune)
void	setLyapunov(double Lyapunov)
void	setOrbit(boolean orbit)
void	setRelativeParticleDisctribution(RelativeParticleDistribution relatvieParticleDistribution)
void	setTurns(java.lang.Integer turns)

Method Detail

setTurns

void setTurns(java.lang.Integer turns)

Parameters:

turns - Number of turns to track

getTurns

java.lang.Integer getTurns()

Returns:

Number of turns to track

setFastTune

void setFastTune(boolean fastTune)

Parameters:

fastTune - If true, the only tunes of the particle tracked is returned

isFastTune

boolean isFastTune()

Returns:

If true, the only tunes of the particle tracked is returned

setLyapunov

void setLyapunov(double Lyapunov)

Parameters:

Lyapunov - The launch distance between two companion particles added to the x coordinate

getLyapunov

double getLyapunov()

Returns:

The launch distance between two companion particles added to the x coordinate

setOrbit

void setOrbit(boolean orbit)

Parameters:

orbit - If set, the flag orbit is true during the tracking and its initialization

isOrbit

boolean isOrbit()

Returns:

If set, the flag orbit is true during the tracking and its initialization

setApertureLimited

void setApertureLimited(boolean apertureLimited)

Parameters:

apertureLimited - if true, the particle reaching aperture limit are considered lost.

isApertureLimited

boolean isApertureLimited()

Returns:

if true, the particle reaching aperture limit are considered lost.

setApertureLimitation

void setApertureLimitation(double x,
                           double px,
                           double y,
                           double py,
                           double t,
                           double pt)

Particles reaching these values are considered lost if this.isApertureLimited()

Parameters:

x -

px -

y -

py -

t -

pt -

getApertureLimitation

java.lang.Double[] getApertureLimitation()

Returns:

Particles reaching these values of x,px,y,py,t,pt are considered lost if this.isApertureLimited()

setRelativeParticleDisctribution

void setRelativeParticleDisctribution(RelativeParticleDistribution relatvieParticleDistribution)

Parameters:

relatvieParticleDistribution - Initial coordinates of the particles to be tracked

getRelativeParticleDistribution

RelativeParticleDistribution getRelativeParticleDistribution()

Returns:

Initial coordinates of the particles to be tracked