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

Class AbstractOCModel

java.lang.Object

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

All Implemented Interfaces:

IOrbitCorrectionModel, IConfigurable, IOrientationMarker

Direct Known Subclasses:

AbstractSVDBasedModel, Bump3CModel, CombinedOrbitCorrectionModel

public abstract class AbstractOCModel
extends Object
implements IOrbitCorrectionModel

Abstract AbstractOCModel class.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	debug	Debug flag
protected String	name	Model name

Constructor Summary

Constructors

Constructor	Description
AbstractOCModel()	RingKeeper constructor comment.

Method Summary

Modifier and Type	Method	Description
String	getName()	getName.
Orientation	getOrientation()	getOrientation.
void	initialize(Orientation ori)	Initializes model for selected orientation.
boolean	isHorizontal()	isHorizontal.
boolean	isVertical()	isVertical.
protected double	read(PositionedData data)	read.
protected double	readOther(PositionedData data)	readOther.
protected void	testCorrectors(ElementList<AbstractCorrector> cor)	setCorrectors method comment.
protected void	testMonitors(ElementList<BPMonitor> monitors)	testMonitors.

Methods inherited from class java.lang.Object

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

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

configure

Methods inherited from interface org.scictrl.mp.orbitcorrect.correction.IOrbitCorrectionModel

calculateCorrection

Field Details

name

protected String name

Model name

debug

protected boolean debug

Debug flag

Constructor Details

AbstractOCModel

public AbstractOCModel()

RingKeeper constructor comment.

Method Details

getName

public String getName()

getName.

Specified by:

getName in interface IOrbitCorrectionModel

Returns:

java.lang.String

getOrientation

public Orientation getOrientation()

getOrientation.

Specified by:

getOrientation in interface IOrientationMarker

Returns:

a Orientation object

read

protected double read(PositionedData data)

read.

Parameters:

data - PositionedData

Returns:

double

readOther

protected double readOther(PositionedData data)

readOther.

Parameters:

data - PositionedData

Returns:

double

testCorrectors

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

setCorrectors method comment.

Parameters:

cor - a ElementList object

Throws:

InconsistentDataException - if any.

testMonitors

protected void testMonitors(ElementList<BPMonitor> monitors)
                     throws InconsistentDataException

testMonitors.

Parameters:

monitors - a ElementList object

Throws:

InconsistentDataException - if any.

isHorizontal

public boolean isHorizontal()

isHorizontal.

Specified by:

isHorizontal in interface IOrientationMarker

Returns:

a boolean

isVertical

public boolean isVertical()

isVertical.

Specified by:

isVertical in interface IOrientationMarker

Returns:

a boolean

initialize

public void initialize(Orientation ori)

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

Specified by:

initialize in interface IOrbitCorrectionModel

Parameters:

ori - a Orientation object