Module simpa.core

Package simpa.core.api.track

Class BeamTrajectoryObserver

java.lang.Object

simpa.core.api.track.BeamTrajectoryObserver

All Implemented Interfaces:

TrackingObserver

public class BeamTrajectoryObserver
extends Object
implements TrackingObserver

Nested Class Summary

Nested classes/interfaces inherited from interface simpa.core.api.track.TrackingObserver

TrackingObserver.ObserverBehaviour

Constructor Summary

Constructors

Constructor	Description
BeamTrajectoryObserver(TrackingObserver.ObserverBehaviour behaviour)

Method Summary

Modifier and Type	Method	Description
void	finish(Particle p)	Finishes the tracking of the given particle.
TrackingObserver.ObserverBehaviour	getBehaviour()
Map<String,List<TrajectoryData>>	getTrajectoryData()
void	observe(Particle p)	Observe the particle using this observer.
void	writeToFile(String fileName)	Write the trajectory of the particles in a beam hitting this observer to a file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BeamTrajectoryObserver

public BeamTrajectoryObserver(TrackingObserver.ObserverBehaviour behaviour)

Method Details

getBehaviour

public TrackingObserver.ObserverBehaviour getBehaviour()

observe

public void observe(Particle p)

Description copied from interface: TrackingObserver

Observe the particle using this observer.

Specified by:

observe in interface TrackingObserver

Parameters:

p - - Particle to observe

finish

public void finish(Particle p)

Description copied from interface: TrackingObserver

Finishes the tracking of the given particle.

Specified by:

finish in interface TrackingObserver

Parameters:

p - the particle to stop tracking

getTrajectoryData

public Map<String,List<TrajectoryData>> getTrajectoryData()

Returns:

A map containing trajectory for each particle in the beam. The key is the particle name.

writeToFile

public void writeToFile(String fileName)

Write the trajectory of the particles in a beam hitting this observer to a file. Should be called after the beam tracking is finished. If the observer was created with the ObserverBehaviour.STORE_ONLY option the method returns without writing the file.

Parameters:

fileName - The file to write to.