Package org.scictrl.mp.orbitcorrect.correction

Interface IOrbitCorrectionModel

All Superinterfaces:

IConfigurable, IOrientationMarker

All Known Subinterfaces:

ISVDOrbitCorrectionModel

All Known Implementing Classes:

AbstractOCModel, AbstractSVDBasedModel, AbstractSVDOrbitCorrectionModel, Bump3CModel, Bump4CModel, CombinedOrbitCorrectionModel, CorrectorStrengthReductionModel, DefaultOrbitCorrectionModel, EmpiricOrbitCorrectionModel, FixBPMsOrbitCorrectionModel, FrequencyOrbitCorrectionModel, ResponseMatrixBumpModel

public interface IOrbitCorrectionModel
extends IOrientationMarker, IConfigurable

General orbit correction model that calculates correction.

Author:

igor@scictrl.com

Method Summary

Modifier and Type	Method	Description
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.
String	getName()	getName.
void	initialize(Orientation ori)	Initializes model for selected orientation.

Methods inherited from interface org.scictrl.mp.orbitcorrect.IConfigurable

configure

Methods inherited from interface org.scictrl.mp.orbitcorrect.IOrientationMarker

getOrientation, isHorizontal, isVertical

Method Details

calculateCorrection

Correction calculateCorrection(OrbitCorrectionOperator engine)
                        throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.

getName

String getName()

getName.

Returns:

java.lang.String

initialize

void initialize(Orientation ori)

Initializes model for selected orientation. Called by application after instantiated.

Parameters:

ori - a Orientation object