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

Class OrbitInterpolationToolImpl

java.lang.Object

cern.accsoft.steering.jmad.tools.interpolate.OrbitInterpolationToolImpl

All Implemented Interfaces:

OrbitInterpolationTool

public class OrbitInterpolationToolImpl
extends java.lang.Object
implements OrbitInterpolationTool

Constructor Summary

Constructors

Constructor	Description
OrbitInterpolationToolImpl()

Method Summary

Modifier and Type	Method	Description
OrbitInterpolationResult	interpolate(OrbitInterpolationRequest request)	Perform an interpolation according to the given OrbitInterpolationRequest.
void	update(UpdateRequest request)	Update the orbit interpolation tool with the given UpdateRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitInterpolationToolImpl

public OrbitInterpolationToolImpl()

Method Detail

interpolate

public OrbitInterpolationResult interpolate(OrbitInterpolationRequest request)
                                     throws JMadException

Description copied from interface: OrbitInterpolationTool

Perform an interpolation according to the given OrbitInterpolationRequest. OrbitInterpolationTool.update(UpdateRequest) MUST be called at least once before the first usage.

Specified by:

interpolate in interface OrbitInterpolationTool

Parameters:

request - the request containing the information about what to interpolate

Returns:

the result of the interpolation

Throws:

JMadException - in case something goes wrong during the interpolation

update

public void update(UpdateRequest request)
            throws JMadException

Description copied from interface: OrbitInterpolationTool

Update the orbit interpolation tool with the given UpdateRequest. This method MUST be called at least once with a request that initializes the structure ( UpdateRequest.updateStructure(cern.accsoft.steering.jmad.domain.types.enums.JMadPlane) returns true for all planes required) before the interpolation is used.

Specified by:

update in interface OrbitInterpolationTool

Parameters:

request - the UpdateRequest containing the data to be used for the update.

Throws:

JMadException - in case the update fails