Package org.scictrl.mp.orbitcorrect.utilities

Class Orbit

java.lang.Object

org.scictrl.mp.orbitcorrect.utilities.Orbit

public final class Orbit
extends Object

Orbit is class that incapsulates orbit at some timepoint. For execution efficiency it is by design non-modifiable class. Orbit information is provided trough constructor and stored in final arrays and should not be changed afterwards.

Author:

igor@kriznar.com

Constructor Summary

Constructors

Constructor	Description
Orbit(ElementList<BPMonitor> bpms, double[] x, double[] z)	Constructor for Orbit.
Orbit(ElementList<BPMonitor> bpms, Orbit ref)	Creates new Orbit object from BPMs and reference.
Orbit(Orbit raw, Orbit ref)	Creates new orbit from raw orbit and reference orbit.

Method Summary

Modifier and Type	Method	Description
double	getAvg(Orientation ori)	Getter for the field avg.
ElementList<BPMonitor>	getBPMs()	getBPMs.
double	getMax(Orientation ori)	Getter for the field max.
double	getPosition(Orientation ori, int i)	getPosition.
double	getPosition(Orientation ori, String bpm)	getPosition.
double[]	getPositions(Orientation ori)	Getter for the field positions.
double	getRms(Orientation ori)	Getter for the field rms.
double	getStd(Orientation ori)	Getter for the field std.
org.scictrl.csshell.Timestamp	getTime()	Getter for the field time.
void	print(PrintWriter pw)	print.
void	printCompact(PrintWriter pw)	printCompact.
void	printCompactStats(PrintWriter pw)	printCompactStats.
String	toStringFull()	toStringFull.
String	toStringStatistics()	toStringStatistics.

Methods inherited from class java.lang.Object

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

Constructor Details

Orbit

public Orbit(ElementList<BPMonitor> bpms,
 Orbit ref)

Creates new Orbit object from BPMs and reference.

Parameters:

bpms - the orbit provided as BPM objects.

ref - the reference, can be null.

Orbit

public Orbit(Orbit raw,
 Orbit ref)

Creates new orbit from raw orbit and reference orbit.

Parameters:

raw - the raw orbit information

ref - the reference for the orbit

Orbit

public Orbit(ElementList<BPMonitor> bpms,
 double[] x,
 double[] z)

Constructor for Orbit.

Parameters:

bpms - a ElementList object

x - an array of

invalid reference

double

objects

z - an array of

invalid reference

double

objects

Method Details

getPositions

public double[] getPositions(Orientation ori)

Getter for the field positions.

Parameters:

ori - a Orientation object

Returns:

an array of

invalid reference

double

objects

getAvg

public double getAvg(Orientation ori)

Getter for the field avg.

Parameters:

ori - a Orientation object

Returns:

a double

getRms

public double getRms(Orientation ori)

Getter for the field rms.

Parameters:

ori - a Orientation object

Returns:

a double

getStd

public double getStd(Orientation ori)

Getter for the field std.

Parameters:

ori - a Orientation object

Returns:

a double

getMax

public double getMax(Orientation ori)

Getter for the field max.

Parameters:

ori - a Orientation object

Returns:

a double

getBPMs

public ElementList<BPMonitor> getBPMs()

getBPMs.

Returns:

a ElementList object

toStringStatistics

public String toStringStatistics()

toStringStatistics.

Returns:

a String object

toStringFull

public String toStringFull()

toStringFull.

Returns:

a String object

printCompact

public void printCompact(PrintWriter pw)

printCompact.

Parameters:

pw - a PrintWriter object

printCompactStats

public void printCompactStats(PrintWriter pw)

printCompactStats.

Parameters:

pw - a PrintWriter object

print

public void print(PrintWriter pw)

print.

Parameters:

pw - a PrintWriter object

getTime

public org.scictrl.csshell.Timestamp getTime()

Getter for the field time.

Returns:

a Timestamp object

getPosition

public double getPosition(Orientation ori,
 int i)

getPosition.

Parameters:

ori - a Orientation object

i - a int

Returns:

a double

getPosition

public double getPosition(Orientation ori,
 String bpm)

getPosition.

Parameters:

ori - a Orientation object

bpm - a String object

Returns:

a double