Package org.scictrl.mp.orbitcorrect.correction.automatic

Class StepAutomaticOC

java.lang.Object

org.scictrl.mp.orbitcorrect.correction.automatic.AbstractAutomaticOCModel

org.scictrl.mp.orbitcorrect.correction.automatic.StepAutomaticOC

All Implemented Interfaces:

IAutomaticOCModel, IConfigurable

public class StepAutomaticOC
extends AbstractAutomaticOCModel

Step based automation model. Does predefined steps of selected correction method.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AOC_MIN_CORRECTOR	Constant AOC_MIN_CORRECTOR="aoc.minCorrector"
protected double	minCorrectorChange	If calculated corrector changes in mrad are lower than this, then correction is skipped and goes into relaxation.

Fields inherited from class org.scictrl.mp.orbitcorrect.correction.automatic.AbstractAutomaticOCModel

log, name, NOT_READY_ABORT_MESSAGE, NOT_READY_MESSAGE, timestampTimeout

Constructor Summary

Constructors

Constructor	Description
StepAutomaticOC()	TimeBasedAutomaticOC constructor comment.

Method Summary

Modifier and Type	Method	Description
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
protected boolean	executeCorectionStep(Orientation ori, AutomaticOrbitCorrectionOperator operator, boolean dryRun)	executeCorectionStep.
protected void	executeLoop(AutomaticOrbitCorrectionOperator operator, int count, boolean dryRun)	Executes single correction loop, which is doing correcting until no optimization is necessary.
protected void	executeLoopStep(AutomaticOrbitCorrectionOperator operator, int count, boolean dryRun)	Implementing method, which executes correction for specified orientation until new rms is not worse or equal.
protected void	prepareOnStart(AutomaticOrbitCorrectionOperator operator)	This method is called once when automatic model is started, implementator migth override this method to add own initialization.
void	setMinCorrectorChange(double ch)	Setter for the field minCorrectorChange.
protected void	waitForNextLoop(AutomaticOrbitCorrectionOperator controller)	waitForNextLoop.

Methods inherited from class org.scictrl.mp.orbitcorrect.correction.automatic.AbstractAutomaticOCModel

executeContinuous, executeSingleLoop, getName, setName, toString

Methods inherited from class java.lang.Object

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

Field Details

AOC_MIN_CORRECTOR

public static final String AOC_MIN_CORRECTOR

Constant AOC_MIN_CORRECTOR="aoc.minCorrector"

See Also:

• Constant Field Values

minCorrectorChange

protected double minCorrectorChange

If calculated corrector changes in mrad are lower than this, then correction is skipped and goes into relaxation.

Constructor Details

StepAutomaticOC

public StepAutomaticOC()

TimeBasedAutomaticOC constructor comment.

Method Details

executeLoopStep

protected void executeLoopStep(AutomaticOrbitCorrectionOperator operator,
 int count,
 boolean dryRun)

Implementing method, which executes correction for specified orientation until new rms is not worse or equal.

Parameters:

operator - the operator for this process

count - controls how deep this recursion goes. If less then 0, then there is no limit, if more than 0, then can go deeper for given count.

dryRun - a boolean

executeCorectionStep

protected boolean executeCorectionStep(Orientation ori,
 AutomaticOrbitCorrectionOperator operator,
 boolean dryRun)

executeCorectionStep.

Parameters:

ori - a Orientation object

operator - a AutomaticOrbitCorrectionOperator object

dryRun - a boolean

Returns:

a boolean

executeLoop

protected void executeLoop(AutomaticOrbitCorrectionOperator operator,
 int count,
 boolean dryRun)

Executes single correction loop, which is doing correcting until no optimization is necessary. Creation date: (09.04.2001 16:55:55)

Specified by:

executeLoop in class AbstractAutomaticOCModel

Parameters:

operator - the operator visitor

count - a int

dryRun - a boolean

prepareOnStart

protected void prepareOnStart(AutomaticOrbitCorrectionOperator operator)

This method is called once when automatic model is started, implementator migth override this method to add own initialization.

Overrides:

prepareOnStart in class AbstractAutomaticOCModel

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

setMinCorrectorChange

public void setMinCorrectorChange(double ch)

Setter for the field minCorrectorChange.

Parameters:

ch - a double

configure

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

configure.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractAutomaticOCModel

Parameters:

conf - a Configuration object

waitForNextLoop

protected void waitForNextLoop(AutomaticOrbitCorrectionOperator controller)

waitForNextLoop.

Specified by:

waitForNextLoop in class AbstractAutomaticOCModel

Parameters:

controller - a AutomaticOrbitCorrectionOperator object