Package org.scictrl.mp.orbitcorrect.accessories

Class DefaultGenericMagnetCalculator

java.lang.Object

org.scictrl.mp.orbitcorrect.accessories.AbstractMagnetCalculator

org.scictrl.mp.orbitcorrect.accessories.DefaultGenericMagnetCalculator

All Implemented Interfaces:

Cloneable, IMagnetCalculatorModel

public class DefaultGenericMagnetCalculator
extends AbstractMagnetCalculator
implements IMagnetCalculatorModel

DefaultGenericMagnetCalculator is used to calculate currents from field strengths and vice versa.

Author:

igor@scictrl.com

See Also:

• AbstractMagnetCalculator
• IMagnetCalculatorModel

Field Summary

Fields inherited from class org.scictrl.mp.orbitcorrect.accessories.AbstractMagnetCalculator

e, energy

Constructor Summary

Constructors

Constructor	Description
DefaultGenericMagnetCalculator(String name, PolynomialFunction trans)	Constructor for DefaultGenericMagnetCalculator.

Method Summary

Modifier and Type	Method	Description
double	calcCurrent(double fieldStrength)	calcCurrent.
double	calcFieldStrength(double current)	calcFieldStrength.
Object	clone()	Clones AbstractMagnetCalculator and its values.

Methods inherited from class org.scictrl.mp.orbitcorrect.accessories.AbstractMagnetCalculator

getEnergy, getName, setEnergy

Methods inherited from class java.lang.Object

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

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

getEnergy, getName, setEnergy

Constructor Details

DefaultGenericMagnetCalculator

public DefaultGenericMagnetCalculator(String name,
 PolynomialFunction trans)

Constructor for DefaultGenericMagnetCalculator.

Parameters:

name - a String object

trans - PolynomialFunction

Method Details

calcCurrent

public double calcCurrent(double fieldStrength)

calcCurrent.

Calculates current for gven magnet from given field strength.

Specified by:

calcCurrent in interface IMagnetCalculatorModel

Parameters:

fieldStrength - double

Returns:

double

calcFieldStrength

public double calcFieldStrength(double current)

calcFieldStrength.

Calculates field strength for given magnet at given current.

Specified by:

calcFieldStrength in interface IMagnetCalculatorModel

Parameters:

current - double

Returns:

double

clone

public Object clone()

Clones AbstractMagnetCalculator and its values. Clones DefaultGenericMagnetCalculator.

Overrides:

clone in class AbstractMagnetCalculator