Package org.scictrl.mp.orbitcorrect.accessories

Class DefaultCurrentApplyModel

java.lang.Object

org.scictrl.mp.orbitcorrect.accessories.DefaultCurrentApplyModel

All Implemented Interfaces:

IConfigurable, ICurrentApplyModel

public final class DefaultCurrentApplyModel
extends Object
implements ICurrentApplyModel

This is default implementation of ICurrentApplyModel. It calculates AVG value of added currents.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
final ElementList<AbstractCalibratedMagnet>	magnets	ElementList of magnets that contribute to AVG value of current.

Constructor Summary

Constructors

Constructor	Description
DefaultCurrentApplyModel()	DefaultCurrentApplyModel constructor.

Method Summary

Modifier and Type	Method	Description
void	addCurrentValue(double current, AbstractCalibratedMagnet magnet)	addCurrentValue.
void	configure(org.apache.commons.configuration.Configuration conf)	configure.
double	getCurrent()	getCurrent.
int	getValueCount()	getValueCount.
void	reset()	reset.

Methods inherited from class java.lang.Object

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

Field Details

magnets

public final ElementList<AbstractCalibratedMagnet> magnets

ElementList of magnets that contribute to AVG value of current.

Constructor Details

DefaultCurrentApplyModel

public DefaultCurrentApplyModel()

DefaultCurrentApplyModel constructor.

Method Details

addCurrentValue

public void addCurrentValue(double current,
 AbstractCalibratedMagnet magnet)

addCurrentValue.

Adds magnet and its current to arrays.This currents are used to calculate AVG value of currents on given magnets.

Specified by:

addCurrentValue in interface ICurrentApplyModel

Parameters:

current - a double

magnet - a AbstractCalibratedMagnet object

getCurrent

public double getCurrent()
                  throws InconsistentDataException,
IllegalStateException

getCurrent.

getCurrent returns average value of added currents. If RMS of currents differes from AVS more than DataBush precision, InconsistentDataException exception is thrown. Fields magnets and values are cleard.

Specified by:

getCurrent in interface ICurrentApplyModel

Returns:

a double

Throws:

InconsistentDataException - if any.

IllegalStateException - if any.

getValueCount

public int getValueCount()

getValueCount.

Returnes the number of currents that contribute to AVG.

Specified by:

getValueCount in interface ICurrentApplyModel

Returns:

a int

reset

public void reset()

reset.

Cleares magnets and values.After reseting one could calculate new AVG.

Specified by:

reset in interface ICurrentApplyModel

configure

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

configure.

Specified by:

configure in interface IConfigurable

Parameters:

conf - a Configuration object