Package org.scictrl.mp.orbitcorrect.accessories

Class AbstractMagnetCalculator

java.lang.Object

org.scictrl.mp.orbitcorrect.accessories.AbstractMagnetCalculator

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DefaultBendingCalculator, DefaultGenericMagnetCalculator

public abstract class AbstractMagnetCalculator
extends Object
implements Cloneable

AbstractMagnetCalculator implements IMagnetCalculatorModel and extends its functionality.

Author:

igor@scictrl.com

See Also:

• IMagnetCalculatorModel

Field Summary

Fields

Modifier and Type	Field	Description
protected double	e	Electron charge.
protected double	energy	Energy of electrons in GeV.

Constructor Summary

Constructors

Constructor	Description
AbstractMagnetCalculator(String name)	AbstractMagnetCalculator constructor that sets given parameter to field.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clones AbstractMagnetCalculator and its values.
double	getEnergy()	Returns electrons energy.
String	getName()	Returns name.
void	setEnergy(double energy)	Sets energy for electrons.

Methods inherited from class java.lang.Object

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

Field Details

energy

protected double energy

Energy of electrons in GeV.

e

protected double e

Electron charge.

Constructor Details

AbstractMagnetCalculator

public AbstractMagnetCalculator(String name)

AbstractMagnetCalculator constructor that sets given parameter to field.

Parameters:

name - java.lang.String

Method Details

clone

public Object clone()

Clones AbstractMagnetCalculator and its values.

Overrides:

clone in class Object

getEnergy

public double getEnergy()

Returns electrons energy.

Returns:

electrons energy

getName

public String getName()

Returns name.

Returns:

a String object

setEnergy

public void setEnergy(double energy)

Sets energy for electrons.

Parameters:

energy - a double