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

Class MagnetList

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractProtectedList<AbstractMagnetElement>

org.scictrl.mp.orbitcorrect.model.optics.AbstractProtectedMagnetList<AbstractMagnetElement>

org.scictrl.mp.orbitcorrect.model.optics.MagnetList

public class MagnetList
extends AbstractProtectedMagnetList<AbstractMagnetElement>

MagnetList class.

Author:

igor@scictrl.com

Field Summary

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

dl, owner, type

Method Summary

Modifier and Type	Method	Description
int	apply()	This method execute apply methon on owner of this list.
AbstractMagnetElement[]	toMagnetArray()	This method generate and return array of AbstractMagnetElement elements.
int	update()	This method reads current from PowerSupply and transforms it to magnetic properties and sets it to list's elements.

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

getPowerSupplies

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

add, contains, get, get, getOwner, isEmpty, iterator, iterator, iterator, size, toArray, toElementList, toString

Methods inherited from class java.lang.Object

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

Method Details

apply

public int apply()
          throws InconsistentDataException,
IllegalStateException,
DataBushPackedException

This method execute apply methon on owner of this list.

Returns:

a int integer which indicate if method succeded

Throws:

InconsistentDataException - if different bendings in list demands different current.

IllegalStateException - if any.

DataBushPackedException - if any.

toMagnetArray

public AbstractMagnetElement[] toMagnetArray()

This method generate and return array of AbstractMagnetElement elements.

Returns:

an array of AbstractMagnetElement objects

update

public int update()
           throws IllegalStateException,
DataBushPackedException

This method reads current from PowerSupply and transforms it to magnetic properties and sets it to list's elements.

Returns:

a int

Throws:

IllegalStateException - if any.

DataBushPackedException - if any.