Package org.scictrl.mp.orbitcorrect.model.optics

Class AbstractMagnetElement

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractMagnetElement

All Implemented Interfaces:

Cloneable, ISimpleElement

Direct Known Subclasses:

AbstractCalibratedMagnet, Septum

public abstract class AbstractMagnetElement
extends AbstractTransferElement

AbstractMagnetElement represent element that generate quasi-static magnet field. It has pointer to PowerSupply

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PR_POWER_SUPPLY	Constant PR_POWER_SUPPLY=6
protected PowerSupply	psH	Associated power supply object.

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

length, matrices, matrix, PR_LENGTH

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

PR_POSITION, PR_REL_FROM, PR_REL_POSITION

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

lastActionResult, owner, PR_ELEMENT_NAME, PR_VIRTUAL

Constructor Summary

Constructors

Constructor	Description
AbstractMagnetElement(String name)	Constructs AbstractMagnetElement with specified name and default parameter's values.
AbstractMagnetElement(String name, boolean virtual, double position, double relpos, String relFrom, double length, String ps)	Constructs the AbstractMagnetElement with specified parameters.

Method Summary

Modifier and Type	Method	Description
PowerSupply	getPowerSupply()	This method return PowerSupply which controls power supply, physically connected to this element.
String	getPS()	This method returns name of power supply.
void	setWith(Object[] par)	Sets parameters values of this element to those in parameter array.
String	toString()	Returns the string representation of this element.

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

clone, getAlpha1, getAlpha2, getBeta1, getBeta2, getDispersion1, getDispersion2, getLength, getMatrix, getQ1, getQ2, newMatrix, newMatrix, setLength

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

getAlpha, getBeta, getDispersion, getIndex, getPosition, getQ, getRelFrom, getRelPosition, setPosition, setRelFrom, setRelPosition

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

descriptor, elType, equals, getLastActionResult, getName, getOwner, getVirtual, hashCode, isInitialized, isVirtual, setVirtual, throwISE

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

psH

protected PowerSupply psH

Associated power supply object.

PR_POWER_SUPPLY

public static final int PR_POWER_SUPPLY

Constant PR_POWER_SUPPLY=6

See Also:

• Constant Field Values

Constructor Details

AbstractMagnetElement

public AbstractMagnetElement(String name)

Constructs AbstractMagnetElement with specified name and default parameter's values.

Parameters:

name - a String name of transfer element

AbstractMagnetElement

public AbstractMagnetElement(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom,
 double length,
 String ps)

Constructs the AbstractMagnetElement with specified parameters.

Parameters:

name - a String object

virtual - a boolean

position - a double

relpos - a double

relFrom - a String object

length - a double

ps - a String object

Method Details

getPS

public String getPS()

This method returns name of power supply.

Returns:

ps name of power supply, specified by constructor.

getPowerSupply

public PowerSupply getPowerSupply()

This method return PowerSupply which controls power supply, physically connected to this element.

Returns:

a PowerSupply object

See Also:

• PowerSupply

setWith

public void setWith(Object[] par)
             throws IllegalStateException

Sets parameters values of this element to those in parameter array. As parameter must be used such array as for dynamical construction of new instance of this class. Current values are overriden for each not null object in array.

setWith.

setWith.

setWith.

Overrides:

setWith in class AbstractTransferElement

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

• AbstractDataBushElement.setWith(java.lang.Object[])

toString

public String toString()

Returns the string representation of this element. Returns string describing this element. String is formated in input-file code. Returns a String that represents the value of this object.

toString.

toString.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractTransferElement

See Also:

• AbstractDataBushElement.toString()