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

Class AbstractAutomaticOCModel

java.lang.Object

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

All Implemented Interfaces:

IAutomaticOCModel, IConfigurable

Direct Known Subclasses:

FastModeAutomaticOC, StepAutomaticOC, TimeBasedAutomaticOC

public abstract class AbstractAutomaticOCModel
extends Object
implements IAutomaticOCModel

Abstract AbstractAutomaticOCModel class.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	log	Logger
protected String	name	Model name
static final String	NOT_READY_ABORT_MESSAGE	Constant NOT_READY_ABORT_MESSAGE="Some devices not ready, borting.

Constructor Summary

Constructors

Constructor	Description
AbstractAutomaticOCModel()	AbstractAOCModel constructor comment.

Method Summary

Modifier and Type	Method	Description
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
void	executeContinuous(AutomaticOrbitCorrectionOperator operator)	Executes the AOC operation, called from execution thread started by AutomaticOrbitCorrectionOperator.
protected abstract void	executeLoop(AutomaticOrbitCorrectionOperator operator, int steps, boolean dryRun)	Executes single correction loop, which is doing correcting until no optimization is necessary.
void	executeSingleLoop(AutomaticOrbitCorrectionOperator operator, int steps, boolean dryRun)	Executes the AOC operation, called from execution thread started by AutomaticOrbitCorrectionOperator.
String	getName()	getName.
protected void	prepareOnStart(AutomaticOrbitCorrectionOperator operator)	This method is called once when automatic model is started, implementator migth override this method to add own initialization.
protected void	setName(String name)	Setter for the field name.
String	toString()	Returns a String that represents the value of this object.
protected abstract void	waitForNextLoop(AutomaticOrbitCorrectionOperator controller)	waitForNextLoop.

Methods inherited from class java.lang.Object

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

Field Details

NOT_READY_MESSAGE

public static final String NOT_READY_MESSAGE

Constant NOT_READY_MESSAGE="Some devices not ready, skipping correc"{trunked}

See Also:

• Constant Field Values

NOT_READY_ABORT_MESSAGE

public static final String NOT_READY_ABORT_MESSAGE

Constant NOT_READY_ABORT_MESSAGE="Some devices not ready, borting. Could "{trunked}

See Also:

• Constant Field Values

timestampTimeout

protected int timestampTimeout

Update timestamp timeout

name

protected String name

Model name

log

protected org.apache.logging.log4j.Logger log

Logger

Constructor Details

AbstractAutomaticOCModel

public AbstractAutomaticOCModel()

AbstractAOCModel constructor comment.

Method Details

executeLoop

protected abstract void executeLoop(AutomaticOrbitCorrectionOperator operator,
 int steps,
 boolean dryRun)
                             throws Exception

Executes single correction loop, which is doing correcting until no optimization is necessary.

Parameters:

operator - the operator visitor

steps - a int

dryRun - a boolean

Throws:

Exception - if any.

executeSingleLoop

public void executeSingleLoop(AutomaticOrbitCorrectionOperator operator,
 int steps,
 boolean dryRun)

Executes the AOC operation, called from execution thread started by AutomaticOrbitCorrectionOperator.

The correction loop is performed until correction model decided that can correct no more. Some correction loops are executed in steps, the number of steps to go is controlled with steps parameter.

Executes single correction loop once, which is doing correcting until no optimization is necessary or specified number of steps..

Specified by:

executeSingleLoop in interface IAutomaticOCModel

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

steps - controls how many steps deep the loop recursion goes. If less then 0, then there is no step limit and loop is executed till end, if more than 0, then can go deeper for given count.

dryRun - a boolean

executeContinuous

public void executeContinuous(AutomaticOrbitCorrectionOperator operator)

Executes the AOC operation, called from execution thread started by AutomaticOrbitCorrectionOperator.

Specified by:

executeContinuous in interface IAutomaticOCModel

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

getName

public String getName()

getName.

Specified by:

getName in interface IAutomaticOCModel

Returns:

a String object

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.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

setName

protected void setName(String name)

Setter for the field name.

Parameters:

name - a String object

toString

public String toString()

Returns a String that represents the value of this object.

Overrides:

toString in class Object

waitForNextLoop

protected abstract void waitForNextLoop(AutomaticOrbitCorrectionOperator controller)

waitForNextLoop.

Parameters:

controller - a AutomaticOrbitCorrectionOperator object

configure

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

configure.

Specified by:

configure in interface IConfigurable

Parameters:

conf - a Configuration object