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

Interface TrackResultRequest

All Known Implementing Classes:

TrackResultRequestImpl

public interface TrackResultRequest

Defines the information wanted in the TrackResult

Method Summary

Modifier and Type	Method	Description
java.lang.Double[]	getApertureLimitation()
java.lang.Integer	getPrintFrequency()
RelativeParticleDistribution	getRelativeParticleDistribution()
java.lang.Integer	getTurns()
boolean	isApertureLimited()
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	setPrintFrequency(java.lang.Integer printfreq)
void	setRelativeParticleDisctribution(RelativeParticleDistribution relatvieParticleDistribution)
void	setTurns(java.lang.Integer turns)

Method Detail

setTurns

void setTurns(java.lang.Integer turns)

Parameters:

turns - number of turn to track

getTurns

java.lang.Integer getTurns()

Returns:

number of turns to track

setPrintFrequency

void setPrintFrequency(java.lang.Integer printfreq)

Parameters:

printfreq - The properties of the particles tracked are stored every printfreq turns

getPrintFrequency

java.lang.Integer getPrintFrequency()

Returns:

The properties of the particles tracked are stored every printfrequency turns

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