Package org.scictrl.mp.orbitcorrect.correction

Class OrbitCorrectionController

java.lang.Object

org.scictrl.mp.orbitcorrect.correction.OrbitCorrectionController

All Implemented Interfaces:

IConfigurable

public final class OrbitCorrectionController
extends Object
implements IConfigurable

Static part of OrbitCorrection procedure, holds references to models and data, which does not change through correction procedure.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AOC_HORIZONTAL	Constant AOC_HORIZONTAL="aoc.horizontal"
static final String	AOC_MIN_BEAM_CURRENT	Constant AOC_MIN_BEAM_CURRENT="aoc.minBeamCurrent"
static final String	AOC_STEP_WAIT_TIME	Constant AOC_STEP_WAIT_TIME="aoc.stepWaitTime"
static final String	AOC_VERTICAL	Constant AOC_VERTICAL="aoc.vertical"
protected int	maxNumberOfSteps	Maximum number of steps correction will make when applying correctors.

Constructor Summary

Constructors

Constructor	Description
OrbitCorrectionController()	Constructor for OrbitCorrectionController.

Method Summary

Modifier and Type	Method	Description
void	addAutomaticOrbitCorrectionListener(IOrbitCorrectionListener listener)	addAutomaticOrbitCorrectionListener.
void	addCorrection(CorrectionInstruction ci)	addCorrection.
void	applyCorrection(OrbitCorrectionOperator op, Correction corr)	applyCorrection.
void	applyUndo(OrbitCorrectionOperator op)	Execute undo operation, if possible.
Correction	calculateCorrection(OrbitCorrectionOperator op, Orientation ori)	calculateCorrection.
ResponseMatrix	calculateResponseMatrix(OrbitCorrectionOperator op, Orientation ori)	calculateResponseMatrix.
boolean	canUndo()	Returns true if undo operation can be executed.
void	checkBeamCurrent(AutomaticOrbitCorrectionOperator operator)	checkBeamCurrent.
String[]	checkBPMs(ElementList<BPMonitor> bpms)	Makes quick local check of usability of devices and returns array with names of failed devices.
boolean	checkDevices(AutomaticOrbitCorrectionOperator operator, Orientation o, boolean fail)	checkDevices.
String[]	checkPowerSupplies(ElementList<AbstractCorrector> l)	Makes quick local check of usability of devices and returns array with names of failed devices.
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
void	debugDataDump(AutomaticOrbitCorrectionOperator operator)	debugDataDump.
void	dumpData(AutomaticOrbitCorrectionOperator operator)	Dumps all available data into a file for debuggin purposes.
void	fireNewCorrection(Correction correction)	fireNewCorrection.
void	fireProgressReport(double progress, String message)	fireProgressReport.
void	fireStateChange(OrbitCorrectionOperator.State state, String message)	fireStateChange.
double	getBeamCurrent()	Trys to connect to info server and return current
ElementList<BPMonitor>	getBPMonitors(Orientation ori)	getBPMonitors.
double	getCorrectionScale()	Getter for the field correctionScale.
ElementList<AbstractCorrector>	getCorrectors(Orientation ori)	Getter for the field correctors.
DataBush	getDataBush()	getDataBush.
File	getDataFolder()	Getter for the field dataFolder.
ApplicationEngine	getEngine()	Getter for the field engine.
double	getMaxStep(Orientation ori)	Getter for the field maxStep.
int	getMaxUndo()	Max count of undo history.
double	getMinimalBeamCurrent()	Getter for the field minimalBeamCurrent.
IOrbitCorrectionModel	getOrbitCorrectionModel(Orientation ori)	getOrbitCorrectionModel.
OrbitMonitor	getOrbitMonitor()	Getter for the field orbitMonitor.
long	getStepWaitTime()	Getter for the field stepWaitTime.
void	initialize(ApplicationEngine engine, DataBushServerLocal dbs)	initialize.
protected void	invalidateAll()	invalidateAll.
boolean	isCorrectHorizontal()	isCorrectHorizontal.
boolean	isCorrectVertical()	isCorrectVertical.
boolean	isDebugDataEnabled()	isDebugDataEnabled.
boolean	isMinimalBeamCurrentEnabled()	isMinimalBeamCurrentEnabled.
boolean	isRFStepping()	isRFStepping.
PrintWriter	newDataFile()	Creates new PrintWirtte on new file, where data should be written.
void	removeAutomaticOrbitCorrectionListener(IOrbitCorrectionListener listener)	removeAutomaticOrbitCorrectionListener.
void	sendMailNotification(String message, String debug)	sendMailNotification.
void	setBPMonitors(ElementList<BPMonitor> l, Orientation ori)	setBPMonitors.
void	setCorrectHorizontal(boolean newCorrectHorizontal)	Setter for the field correctHorizontal.
void	setCorrectionScale(double correctionScale)	Setter for the field correctionScale.
void	setCorrectors(ElementList<AbstractCorrector> l, Orientation ori)	Setter for the field correctors.
void	setCorrectVertical(boolean newCorrectVertical)	Setter for the field correctVertical.
void	setDebugDataEnabled(boolean b)	Setter for the field debugDataEnabled.
void	setMaxNumberOfSteps(int maxNumberOfSteps)	Setter for the field maxNumberOfSteps.
void	setMaxStep(Orientation ori, double step)	Setter for the field maxStep.
void	setMaxUndo(int maxUndo)	Sets max count of undo history.
void	setMinimalBeamCurrent(double newMinimalBeamCurrent)	Setter for the field minimalBeamCurrent.
void	setMinimalBeamCurrentEnabled(boolean b)	setMinimalBeamCurrentEnabled.
void	setOrbitCorrectionModel(IOrbitCorrectionModel model)	setOrbitCorrectionModel.
void	setStepWaitTime(long stepWaitTime)	Setter for the field stepWaitTime.
void	signalAutomaticOrbitCorrectionEnded()	signalAutomaticOrbitCorrectionEnded.
void	signalAutomaticOrbitCorrectionStarted()	signalAutomaticOrbitCorrectionStarted.
void	signalOrbitCorrectionEnded()	signalOrbitCorrectionEnded.
void	signalOrbitCorrectionStarted()	signalOrbitCorrectionStarted.
AutomaticOrbitCorrectionOperator	startAutomaticOperator()	startAutomaticOperator.
OrbitCorrectionOperator	startOperator()	startOperator.
boolean	startTest(AutomaticOrbitCorrectionOperator operator)	startTest.
void	testBeamCurrent(AutomaticOrbitCorrectionOperator operator)	testBeamCurrent.
String[]	testBPMs(ElementList<BPMonitor> bpms)	Makes test of devices and returns array with names of failed devices.
boolean	testDevices(AutomaticOrbitCorrectionOperator operator, Orientation o, boolean fail)	testDevices.
boolean	testMain(AutomaticOrbitCorrectionOperator operator, boolean fail)	testMain.
void	testOnStart(AutomaticOrbitCorrectionOperator operator)	testOnStart.
String[]	testPowerSupplies(ElementList<AbstractCorrector> l)	Makes test of devices and returns array with names of failed devices.

Methods inherited from class java.lang.Object

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

Field Details

AOC_MIN_BEAM_CURRENT

public static final String AOC_MIN_BEAM_CURRENT

Constant AOC_MIN_BEAM_CURRENT="aoc.minBeamCurrent"

See Also:

• Constant Field Values

AOC_STEP_WAIT_TIME

public static final String AOC_STEP_WAIT_TIME

Constant AOC_STEP_WAIT_TIME="aoc.stepWaitTime"

See Also:

• Constant Field Values

AOC_HORIZONTAL

public static final String AOC_HORIZONTAL

Constant AOC_HORIZONTAL="aoc.horizontal"

See Also:

• Constant Field Values

AOC_VERTICAL

public static final String AOC_VERTICAL

Constant AOC_VERTICAL="aoc.vertical"

See Also:

• Constant Field Values

maxNumberOfSteps

protected int maxNumberOfSteps

Maximum number of steps correction will make when applying correctors. 0 means all steps are applied.

Constructor Details

OrbitCorrectionController

public OrbitCorrectionController()

Constructor for OrbitCorrectionController.

Method Details

addAutomaticOrbitCorrectionListener

public void addAutomaticOrbitCorrectionListener(IOrbitCorrectionListener listener)

addAutomaticOrbitCorrectionListener.

Parameters:

listener - a IOrbitCorrectionListener object

removeAutomaticOrbitCorrectionListener

public void removeAutomaticOrbitCorrectionListener(IOrbitCorrectionListener listener)

removeAutomaticOrbitCorrectionListener.

Parameters:

listener - a IOrbitCorrectionListener object

fireStateChange

public void fireStateChange(OrbitCorrectionOperator.State state,
 String message)

fireStateChange.

Parameters:

state - a OrbitCorrectionOperator.State object

message - a String object

fireNewCorrection

public void fireNewCorrection(Correction correction)

fireNewCorrection.

Parameters:

correction - a Correction object

fireProgressReport

public void fireProgressReport(double progress,
 String message)

fireProgressReport.

Parameters:

progress - a double

message - a String object

getDataFolder

public File getDataFolder()

Getter for the field dataFolder.

Returns:

a File object

newDataFile

public PrintWriter newDataFile()

Creates new PrintWirtte on new file, where data should be written. After data is being written, the stream must be closed in order data to be preserved.

Returns:

a PrintWriter object

sendMailNotification

public void sendMailNotification(String message,
 String debug)

sendMailNotification.

Parameters:

message - a String object

debug - a String object

getOrbitMonitor

public OrbitMonitor getOrbitMonitor()

Getter for the field orbitMonitor.

Returns:

a OrbitMonitor object

getCorrectors

public ElementList<AbstractCorrector> getCorrectors(Orientation ori)

Getter for the field correctors.

Parameters:

ori - a Orientation object

Returns:

a ElementList object

getDataBush

public DataBush getDataBush()

getDataBush.

Returns:

a DataBush object

getBPMonitors

public ElementList<BPMonitor> getBPMonitors(Orientation ori)

getBPMonitors.

Parameters:

ori - a Orientation object

Returns:

a ElementList object

setOrbitCorrectionModel

public void setOrbitCorrectionModel(IOrbitCorrectionModel model)

setOrbitCorrectionModel.

Parameters:

model - a IOrbitCorrectionModel object

getOrbitCorrectionModel

public IOrbitCorrectionModel getOrbitCorrectionModel(Orientation ori)

getOrbitCorrectionModel.

Parameters:

ori - a Orientation object

Returns:

a IOrbitCorrectionModel object

setStepWaitTime

public void setStepWaitTime(long stepWaitTime)

Setter for the field stepWaitTime.

Parameters:

stepWaitTime - a long

getStepWaitTime

public long getStepWaitTime()

Getter for the field stepWaitTime.

Returns:

a long

initialize

public void initialize(ApplicationEngine engine,
 DataBushServerLocal dbs)

initialize.

Parameters:

engine - a ApplicationEngine object

dbs - a DataBushServerLocal object

getEngine

public ApplicationEngine getEngine()

Getter for the field engine.

Returns:

a ApplicationEngine object

invalidateAll

protected void invalidateAll()

invalidateAll.

startOperator

public OrbitCorrectionOperator startOperator()

startOperator.

Returns:

a OrbitCorrectionOperator object

startAutomaticOperator

public AutomaticOrbitCorrectionOperator startAutomaticOperator()

startAutomaticOperator.

Returns:

a AutomaticOrbitCorrectionOperator object

startTest

public boolean startTest(AutomaticOrbitCorrectionOperator operator)

startTest.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

Returns:

a boolean

calculateCorrection

public Correction calculateCorrection(OrbitCorrectionOperator op,
 Orientation ori)
                               throws InconsistentDataException

calculateCorrection.

Parameters:

op - a OrbitCorrectionOperator object

ori - a Orientation object

Returns:

a Correction object

Throws:

InconsistentDataException - if any.

setCorrectors

public void setCorrectors(ElementList<AbstractCorrector> l,
 Orientation ori)

Setter for the field correctors.

Parameters:

l - a ElementList object

ori - a Orientation object

setBPMonitors

public void setBPMonitors(ElementList<BPMonitor> l,
 Orientation ori)

setBPMonitors.

Parameters:

l - a ElementList object

ori - a Orientation object

calculateResponseMatrix

public ResponseMatrix calculateResponseMatrix(OrbitCorrectionOperator op,
 Orientation ori)

calculateResponseMatrix.

Parameters:

op - a OrbitCorrectionOperator object

ori - a Orientation object

Returns:

a ResponseMatrix object

getCorrectionScale

public double getCorrectionScale()

Getter for the field correctionScale.

Returns:

a double

setCorrectionScale

public void setCorrectionScale(double correctionScale)

Setter for the field correctionScale.

Parameters:

correctionScale - a double

applyCorrection

public void applyCorrection(OrbitCorrectionOperator op,
 Correction corr)
                     throws IllegalStateException,
DataBushPackedException,
InconsistentDataException,
ControlSystemException

applyCorrection.

Parameters:

op - a OrbitCorrectionOperator object

corr - a Correction object

Throws:

IllegalStateException - if any.

DataBushPackedException - if any.

InconsistentDataException - if any.

ControlSystemException - if any.

applyUndo

public void applyUndo(OrbitCorrectionOperator op)
               throws IllegalStateException,
DataBushPackedException,
InconsistentDataException,
ControlSystemException

Execute undo operation, if possible.

Parameters:

op - a OrbitCorrectionOperator object

Throws:

IllegalStateException - if any.

DataBushPackedException - if any.

InconsistentDataException - if any.

ControlSystemException - if any.

setMaxNumberOfSteps

public void setMaxNumberOfSteps(int maxNumberOfSteps)

Setter for the field maxNumberOfSteps.

Parameters:

maxNumberOfSteps - a int

signalOrbitCorrectionStarted

public void signalOrbitCorrectionStarted()

signalOrbitCorrectionStarted.

signalOrbitCorrectionEnded

public void signalOrbitCorrectionEnded()

signalOrbitCorrectionEnded.

signalAutomaticOrbitCorrectionStarted

public void signalAutomaticOrbitCorrectionStarted()

signalAutomaticOrbitCorrectionStarted.

signalAutomaticOrbitCorrectionEnded

public void signalAutomaticOrbitCorrectionEnded()

signalAutomaticOrbitCorrectionEnded.

getMaxStep

public double getMaxStep(Orientation ori)

Getter for the field maxStep.

Parameters:

ori - a Orientation object

Returns:

a double

setMaxStep

public void setMaxStep(Orientation ori,
 double step)

Setter for the field maxStep.

Parameters:

ori - a Orientation object

step - a double

configure

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

configure.

Specified by:

configure in interface IConfigurable

Parameters:

conf - a Configuration object

setMaxUndo

public void setMaxUndo(int maxUndo)

Sets max count of undo history.

Parameters:

maxUndo - max count of undo history

getMaxUndo

public int getMaxUndo()

Max count of undo history.

Returns:

max count of undo history

getMinimalBeamCurrent

public double getMinimalBeamCurrent()

Getter for the field minimalBeamCurrent.

Returns:

double

isMinimalBeamCurrentEnabled

public boolean isMinimalBeamCurrentEnabled()

isMinimalBeamCurrentEnabled.

Returns:

a boolean

setMinimalBeamCurrent

public void setMinimalBeamCurrent(double newMinimalBeamCurrent)

Setter for the field minimalBeamCurrent.

Parameters:

newMinimalBeamCurrent - double

setMinimalBeamCurrentEnabled

public void setMinimalBeamCurrentEnabled(boolean b)

setMinimalBeamCurrentEnabled.

Parameters:

b - a boolean

testBeamCurrent

public void testBeamCurrent(AutomaticOrbitCorrectionOperator operator)

testBeamCurrent.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

getBeamCurrent

public double getBeamCurrent()
                      throws Exception

Trys to connect to info server and return current

Returns:

a double

Throws:

Exception - if remote get fails

isRFStepping

public boolean isRFStepping()
                     throws Exception

isRFStepping.

Returns:

a boolean

Throws:

Exception - if any.

testOnStart

public void testOnStart(AutomaticOrbitCorrectionOperator operator)

testOnStart.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

testDevices

public boolean testDevices(AutomaticOrbitCorrectionOperator operator,
 Orientation o,
 boolean fail)

testDevices.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

o - a Orientation object

fail - a boolean

Returns:

a boolean

testMain

public boolean testMain(AutomaticOrbitCorrectionOperator operator,
 boolean fail)

testMain.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

fail - a boolean

Returns:

a boolean

checkDevices

public boolean checkDevices(AutomaticOrbitCorrectionOperator operator,
 Orientation o,
 boolean fail)

checkDevices.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

o - a Orientation object

fail - a boolean

Returns:

a boolean

checkBeamCurrent

public void checkBeamCurrent(AutomaticOrbitCorrectionOperator operator)

checkBeamCurrent.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

testBPMs

public String[] testBPMs(ElementList<BPMonitor> bpms)

Makes test of devices and returns array with names of failed devices.

Parameters:

bpms - a ElementList object

Returns:

array with list of failed devices, never null

checkBPMs

public String[] checkBPMs(ElementList<BPMonitor> bpms)

Makes quick local check of usability of devices and returns array with names of failed devices.

Parameters:

bpms - a ElementList object

Returns:

an array of String objects

testPowerSupplies

public String[] testPowerSupplies(ElementList<AbstractCorrector> l)

Makes test of devices and returns array with names of failed devices.

Parameters:

l - a ElementList object

Returns:

array with list of failed devices, never null

checkPowerSupplies

public String[] checkPowerSupplies(ElementList<AbstractCorrector> l)

Makes quick local check of usability of devices and returns array with names of failed devices.

Parameters:

l - a ElementList object

Returns:

an array of String objects

debugDataDump

public void debugDataDump(AutomaticOrbitCorrectionOperator operator)

debugDataDump.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

dumpData

public void dumpData(AutomaticOrbitCorrectionOperator operator)

Dumps all available data into a file for debuggin purposes.

Parameters:

operator - a AutomaticOrbitCorrectionOperator object

setDebugDataEnabled

public void setDebugDataEnabled(boolean b)

Setter for the field debugDataEnabled.

Parameters:

b - a boolean

isDebugDataEnabled

public boolean isDebugDataEnabled()

isDebugDataEnabled.

Returns:

a boolean

isCorrectHorizontal

public boolean isCorrectHorizontal()

isCorrectHorizontal.

Returns:

boolean

isCorrectVertical

public boolean isCorrectVertical()

isCorrectVertical.

Returns:

boolean

setCorrectHorizontal

public void setCorrectHorizontal(boolean newCorrectHorizontal)

Setter for the field correctHorizontal.

Parameters:

newCorrectHorizontal - boolean

setCorrectVertical

public void setCorrectVertical(boolean newCorrectVertical)

Setter for the field correctVertical.

Parameters:

newCorrectVertical - boolean

addCorrection

public void addCorrection(CorrectionInstruction ci)

addCorrection.

Parameters:

ci - a CorrectionInstruction object

canUndo

public boolean canUndo()

Returns true if undo operation can be executed.

Returns:

true if undo operation can be executed