OrbitInterpolationTool (jmad-core API)

All Known Implementing Classes:

OrbitInterpolationToolImpl
```
public interface OrbitInterpolationTool
```
This interface provides the access to the interpolation of orbits.

Method Summary

All Methods Instance Methods Abstract Methods
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`.

- Method Detail
  - update
```
void update(UpdateRequest request)
     throws JMadException
```
    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.
    
    Parameters:
    
    request - the UpdateRequest containing the data to be used for the update.
    
    Throws:
    
    JMadException - in case the update fails
  - interpolate
```
OrbitInterpolationResult interpolate(OrbitInterpolationRequest request)
                              throws JMadException
```
    Perform an interpolation according to the given OrbitInterpolationRequest. update(UpdateRequest) MUST be called at least once before the first usage.
    
    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