Package org.scictrl.mp.orbitcorrect.correction.models

Class Bump3CModel

java.lang.Object

org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

org.scictrl.mp.orbitcorrect.correction.models.Bump3CModel

All Implemented Interfaces:

IOrbitCorrectionModel, IConfigurable, IOrientationMarker

Direct Known Subclasses:

Bump4CModel

public class Bump3CModel
extends AbstractOCModel

Bump3CModel class.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractOpticalElement	bumpedElement	Bump location at element.
protected double	bumpHeight	Bump height.
protected double	maxCorrection	Max correction value allowed.

Fields inherited from class org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

debug, name

Constructor Summary

Constructors

Constructor	Description
Bump3CModel()	RingKeeper constructor comment.

Method Summary

Modifier and Type	Method	Description
Correction	calculateCorrection(OrbitCorrectionOperator engine)	calculateCorrection.
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
AbstractOpticalElement	getBumpedElement()	Getter for the field bumpedElement.
double	getBumpHeight()	Getter for the field bumpHeight.
protected AbstractCorrector	getCorrector(ElementList<AbstractCorrector> l, int index)	getCorrector.
double	getMaxCorrectionValue()	getMaxCorrectionValue.
protected Correction	makeCorrection(ElementList<AbstractCorrector> correctors, Orbit orbit, ResponseMatrix responseMatrix, DataBush db, OrbitCorrectionOperator op)	makeCorrection.
void	setBumpedElement(AbstractOpticalElement newBumpedElement)	Setter for the field bumpedElement.
void	setBumpHeight(double newBumpHeight)	Setter for the field bumpHeight.
protected void	testCorrectors(ElementList<AbstractCorrector> cor)	setCorrectors method comment.
protected void	testElements(ElementList<AbstractCorrector> correctors, DataBush db)	testElements.

Methods inherited from class org.scictrl.mp.orbitcorrect.correction.models.AbstractOCModel

getName, getOrientation, initialize, isHorizontal, isVertical, read, readOther, testMonitors

Methods inherited from class java.lang.Object

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

Field Details

maxCorrection

protected double maxCorrection

Max correction value allowed.

bumpHeight

protected double bumpHeight

Bump height.

bumpedElement

protected AbstractOpticalElement bumpedElement

Bump location at element.

Constructor Details

Bump3CModel

public Bump3CModel()

RingKeeper constructor comment.

Method Details

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator engine)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

engine - a OrbitCorrectionOperator object

Returns:

double[]

Throws:

InconsistentDataException - if any.

makeCorrection

protected Correction makeCorrection(ElementList<AbstractCorrector> correctors,
 Orbit orbit,
 ResponseMatrix responseMatrix,
 DataBush db,
 OrbitCorrectionOperator op)
                             throws InconsistentDataException

makeCorrection.

Parameters:

correctors - a ElementList object

orbit - a Orbit object

responseMatrix - a ResponseMatrix object

db - a DataBush object

op - a OrbitCorrectionOperator object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.

getCorrector

protected AbstractCorrector getCorrector(ElementList<AbstractCorrector> l,
 int index)

getCorrector.

Parameters:

l - a ElementList object

index - a int

Returns:

a AbstractCorrector object

getBumpedElement

public AbstractOpticalElement getBumpedElement()

Getter for the field bumpedElement.

Returns:

AbstractOpticalElement

getBumpHeight

public double getBumpHeight()

Getter for the field bumpHeight.

Returns:

double

getMaxCorrectionValue

public double getMaxCorrectionValue()

getMaxCorrectionValue.

Returns:

double

setBumpedElement

public void setBumpedElement(AbstractOpticalElement newBumpedElement)

Setter for the field bumpedElement.

Parameters:

newBumpedElement - AbstractOpticalElement

setBumpHeight

public void setBumpHeight(double newBumpHeight)

Setter for the field bumpHeight.

Parameters:

newBumpHeight - double

testCorrectors

protected void testCorrectors(ElementList<AbstractCorrector> cor)
                       throws InconsistentDataException

setCorrectors method comment. setCorrectors method comment.

Overrides:

testCorrectors in class AbstractOCModel

Parameters:

cor - a ElementList object

Throws:

InconsistentDataException - if any.

testElements

protected void testElements(ElementList<AbstractCorrector> correctors,
 DataBush db)
                     throws InconsistentDataException

testElements.

Parameters:

correctors - a ElementList object

db - a DataBush object

Throws:

InconsistentDataException - if any.

configure

public void configure(org.apache.commons.configuration.Configuration conf)

configure.

Parameters:

conf - a Configuration object