Package cern.accsoft.steering.jmad.tools.interpolate

Class SimpleOrbitSegmentCalculator

java.lang.Object

cern.accsoft.steering.jmad.tools.interpolate.SimpleOrbitSegmentCalculator

All Implemented Interfaces:

OrbitSegmentCalculator

public class SimpleOrbitSegmentCalculator
extends java.lang.Object
implements OrbitSegmentCalculator

This class does the actual interpolation of the orbit in one plane for one segment defined by two adjacent monitors.

Constructor Summary

Constructors

Constructor	Description
SimpleOrbitSegmentCalculator(JMadPlane plane)

Method Summary

Modifier and Type	Method	Description
void	addElementToCalculate(Element element)	Add an element to this calculator.
java.util.Map<Element,java.util.Map<MadxTwissVariable,java.lang.Double>>	calculate(Orbit orbit)	Interpolate the orbit for all defined elements.
java.lang.String	getName()
JMadPlane	getPlane()
void	setEndSegmentMonitor(Element element)	Set the monitor at the ending of the segment
void	setIsCycleStartSegment(boolean isCycleStartSegment)	Define that this segments contains the start and end element of the circular machine.
void	setStartSegmentMonitor(Element element)	Set the monitor at the beginning of the segment
boolean	update(Optic optic)	Update the internal transfer matrices according to the optic provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOrbitSegmentCalculator

public SimpleOrbitSegmentCalculator(JMadPlane plane)

Method Detail

setStartSegmentMonitor

public void setStartSegmentMonitor(Element element)

Description copied from interface: OrbitSegmentCalculator

Set the monitor at the beginning of the segment

Specified by:

setStartSegmentMonitor in interface OrbitSegmentCalculator

Parameters:

element - the Element describing the monitor

setEndSegmentMonitor

public void setEndSegmentMonitor(Element element)

Description copied from interface: OrbitSegmentCalculator

Set the monitor at the ending of the segment

Specified by:

setEndSegmentMonitor in interface OrbitSegmentCalculator

Parameters:

element - the Element describing the monitor

addElementToCalculate

public void addElementToCalculate(Element element)

Description copied from interface: OrbitSegmentCalculator

Add an element to this calculator. For each update with a new monitor reading the orbit will be calculated.

Specified by:

addElementToCalculate in interface OrbitSegmentCalculator

Parameters:

element - the element to add to the calculations in this segment

update

public boolean update(Optic optic)

Description copied from interface: OrbitSegmentCalculator

Update the internal transfer matrices according to the optic provided.

Specified by:

update in interface OrbitSegmentCalculator

Parameters:

optic - the optic to update from

Returns:

true if update was successful

calculate

public java.util.Map<Element,java.util.Map<MadxTwissVariable,java.lang.Double>> calculate(Orbit orbit)

Description copied from interface: OrbitSegmentCalculator

Interpolate the orbit for all defined elements. In case something goes wrong an empty map is returned.

Specified by:

calculate in interface OrbitSegmentCalculator

Parameters:

orbit - the orbit to interpolate from

Returns:

the mapping between [element, value mapping] for all elements defined in the segment for the plane defined by OrbitSegmentCalculator.getPlane(). where value mapping may contain orbit and angle

getName

public java.lang.String getName()

Specified by:

getName in interface OrbitSegmentCalculator

Returns:

the name of the calculator.

getPlane

public JMadPlane getPlane()

Specified by:

getPlane in interface OrbitSegmentCalculator

Returns:

the JMadPlane this orbit segment calculator works on

setIsCycleStartSegment

public void setIsCycleStartSegment(boolean isCycleStartSegment)

Description copied from interface: OrbitSegmentCalculator

Define that this segments contains the start and end element of the circular machine.

Specified by:

setIsCycleStartSegment in interface OrbitSegmentCalculator

Parameters:

isCycleStartSegment - set to true if segment contains start and end element.