xal.smf.impl

Class Electromagnet

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

All Implemented Interfaces:

ElementType, MagnetType, DataListener

Direct Known Subclasses:

Dipole, Quadrupole, Sextupole, Solenoid

public abstract class Electromagnet
extends Magnet

Electromagnet is the base class representation of an electromagnet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Electromagnet.Property accessible properties

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_useFieldReadback indicates whether to use the actual field readback or the field setting in the getField() method
static java.lang.String	FIELD_RB_HANDLE field readback handle
protected java.lang.String	mainSupplyId the ID of this magnet's main power supply
static java.lang.String	s_strType the node type

Fields inherited from class xal.smf.impl.Magnet

leff, m_bucMagnet

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Fields inherited from interface xal.smf.impl.qualify.MagnetType

DIPOLE, HORIZONTAL, NO_ORIENTATION, OCT, OCTUPOLE, poles, QUAD, QUADRUPOLE, SEXT, SEXTUPOLE, SOL, SOLENOID, VERTICAL

Constructor Summary

Constructors

Constructor and Description
Electromagnet(java.lang.String strId) Constructor

Method Summary

Modifier and Type	Method and Description
Channel	findChannel(java.lang.String handle) Find the channel for the specified handle searching the main supply if necessary.
double	getCurrent() Get the main power supply current in this electromagnet via ca (A)
int	getCycleState() Gets the cycle state of the magnet.
double	getDesignPropertyValue(java.lang.String propertyName) Get the design value for the specified property
double	getField() Get the field in this electromagnet via ca.
double	getFieldInt() Get the integrated field in this electromagnet T-m/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	getFieldReadback() Get the field in this electromagnet via ca.
double	getFieldSetting() Get the value to which the main power supply's field contribution is set.
java.util.Collection<java.lang.String>	getHandles() Get the channel handles.
Channel[]	getLivePropertyChannels(java.lang.String propertyName) Get the array of channels for the specified property
double	getLivePropertyValue(java.lang.String propertyName, double[] channelValues) Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()
MagnetMainSupply	getMainSupply() Get the main power supply for this magnet.
double	getTotalFieldSetting() Get the value to which the field is set including both the main supply and possible trim supply contributions.
boolean	isPermanent() Since this is an electro-magnet we override the inherited method to advertise this characteristic.
double	lowerAlarmFieldLimit() Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerCurrentLimit() get the main power supply current lower settable limit (A)
double	lowerDisplayFieldLimit() Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerFieldLimit() Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerWarningFieldLimit() Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
void	setCurrent(double newCurrent) set the main power supply current in the magnet (A)
void	setCycleEnable(boolean enable) Set the cycle enable state of the magnet.
void	setField(double newField) Set the main power supply field contribution in the magnet.
void	setUseFieldReadback(boolean useFieldReadback) Set whether or not to use the field readback in the getField() method.
double	toCAFromField(double field) Convert the field value to a channel access value.
double	toFieldFromCA(double rawValue) Convert the raw channel access value to get the field.
void	update(DataAdaptor adaptor) Update the node with data from the provided adaptor.
protected void	updatePowerSupplies(DataAdaptor powerSupplyAdaptor) Update data from the power supply data adaptor.
double	upperAlarmFieldLimit() Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperCurrentLimit() get the main power supply current lower settable limit (A)
double	upperDisplayFieldLimit() Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperFieldLimit() Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperWarningFieldLimit() Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
boolean	useFieldReadback() Determines whether the field readback is used in the getField() method.
void	write(DataAdaptor adaptor) Encode data from the node into the provided adaptor.
protected void	writePowerSupplies(DataAdaptor powerSupplyAdaptor) Write data to the power supply data adaptor.

Methods inherited from class xal.smf.impl.Magnet

addBucket, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getOrientation, getPolarity, getTangField, isCorrector, isHorizontal, isMagnet, isPole, isSkew, isVertical, setDfltField, setMagBucket

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, dataLabel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getEId, getId, getLength, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getType, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface xal.smf.impl.qualify.ElementType

isKindOf

Field Detail

s_strType

public static final java.lang.String s_strType

the node type

See Also:

Constant Field Values

FIELD_RB_HANDLE

public static final java.lang.String FIELD_RB_HANDLE

field readback handle

See Also:

Constant Field Values

_useFieldReadback

protected boolean _useFieldReadback

indicates whether to use the actual field readback or the field setting in the getField() method

mainSupplyId

protected java.lang.String mainSupplyId

the ID of this magnet's main power supply

Constructor Detail

Electromagnet

public Electromagnet(java.lang.String strId)

Constructor

Method Detail

update

public void update(DataAdaptor adaptor)
            throws java.lang.NumberFormatException

Update the node with data from the provided adaptor.

Specified by:

update in interface DataListener

Overrides:

update in class AcceleratorNode

Parameters:

adaptor - The data provider

Throws:

java.lang.NumberFormatException

updatePowerSupplies

protected void updatePowerSupplies(DataAdaptor powerSupplyAdaptor)

Update data from the power supply data adaptor. Get the main power supply information.

Parameters:

powerSupplyAdaptor - The data provider of power supply information.

write

public void write(DataAdaptor adaptor)

Encode data from the node into the provided adaptor. Overrides to provide support for power supplies.

Specified by:

write in interface DataListener

Overrides:

write in class AcceleratorNode

Parameters:

adaptor - The data store

writePowerSupplies

protected void writePowerSupplies(DataAdaptor powerSupplyAdaptor)

Write data to the power supply data adaptor. Put the information about the main power supply into the data adaptor.

Parameters:

powerSupplyAdaptor - The data sink for the power supply information

setUseFieldReadback

public void setUseFieldReadback(boolean useFieldReadback)

Set whether or not to use the field readback in the getField() method.

Parameters:

useFieldReadback - true to use the field readback and false to use the field setting.

useFieldReadback

public boolean useFieldReadback()

Determines whether the field readback is used in the getField() method.

Returns:

true if the field readback is used in getField() and false if instead the field setting is used.

getHandles

public java.util.Collection<java.lang.String> getHandles()

Get the channel handles. Overrides the default method to add handles from the main power supply.

Overrides:

getHandles in class AcceleratorNode

Returns:

The channel handles associated with this node

findChannel

public Channel findChannel(java.lang.String handle)

Find the channel for the specified handle searching the main supply if necessary.

Overrides:

findChannel in class AcceleratorNode

Parameters:

handle - The handle for the channel to get.

Returns:

The channel associated with this node and the specified handle or null if there is no match.

getMainSupply

public MagnetMainSupply getMainSupply()

Get the main power supply for this magnet.

Returns:

The main power supply for this magnet

getDesignPropertyValue

public double getDesignPropertyValue(java.lang.String propertyName)

Get the design value for the specified property

Overrides:

getDesignPropertyValue in class AcceleratorNode

getLivePropertyValue

public double getLivePropertyValue(java.lang.String propertyName,
                                   double[] channelValues)

Get the live property value for the corresponding array of channel values in the order given by getLivePropertyChannels()

Overrides:

getLivePropertyValue in class AcceleratorNode

getLivePropertyChannels

public Channel[] getLivePropertyChannels(java.lang.String propertyName)

Get the array of channels for the specified property

Overrides:

getLivePropertyChannels in class AcceleratorNode

setCycleEnable

public void setCycleEnable(boolean enable)
                    throws ConnectionException,
                           PutException

Set the cycle enable state of the magnet. If enabled, the magnet will be cycled when the field is set.

Parameters:

enable - True to enable cycling; false to disable cycling.

Throws:

ConnectionException

PutException

getCycleState

public int getCycleState()
                  throws ConnectionException,
                         GetException

Gets the cycle state of the magnet. The magnet may be in one of three states: cycle is invalid (field changed in reverse direction of initial setting), cycling in progress or cycle is valid

Returns:

One of CYCLE_INVALID, CYCLING or CYCLE_VALID

Throws:

ConnectionException

GetException

getField

public double getField()
                throws ConnectionException,
                       GetException

Get the field in this electromagnet via ca.

Returns:

the field in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

getFieldReadback

public double getFieldReadback()
                        throws ConnectionException,
                               GetException

Get the field in this electromagnet via ca.

Returns:

the readback field in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

getFieldInt

public double getFieldInt()
                   throws ConnectionException,
                          GetException

Get the integrated field in this electromagnet T-m/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

setField

public void setField(double newField)
              throws ConnectionException,
                     PutException

Set the main power supply field contribution in the magnet. If cycle enable is true then the magnet is cycled before the field is set to the specified value.

Parameters:

newField - is the new field level in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

PutException

getFieldSetting

public double getFieldSetting()
                       throws ConnectionException,
                              GetException

Get the value to which the main power supply's field contribution is set. Note that this is not the readback.

Returns:

the field setting in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

getTotalFieldSetting

public double getTotalFieldSetting()
                            throws ConnectionException,
                                   GetException

Get the value to which the field is set including both the main supply and possible trim supply contributions. Note that this is not the readback.

Returns:

the field setting in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

toFieldFromCA

public final double toFieldFromCA(double rawValue)

Convert the raw channel access value to get the field.

Parameters:

rawValue - the raw channel value

Returns:

the magnetic field in T/m^(n-1)

toCAFromField

public final double toCAFromField(double field)

Convert the field value to a channel access value.

Parameters:

field - the magnetic field in T/m^(n-1)

Returns:

the channel access value

upperFieldLimit

public double upperFieldLimit()
                       throws ConnectionException,
                              GetException

Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

lowerFieldLimit

public double lowerFieldLimit()
                       throws ConnectionException,
                              GetException

Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

upperDisplayFieldLimit

public double upperDisplayFieldLimit()
                              throws ConnectionException,
                                     GetException

Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

lowerDisplayFieldLimit

public double lowerDisplayFieldLimit()
                              throws ConnectionException,
                                     GetException

Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

upperWarningFieldLimit

public double upperWarningFieldLimit()
                              throws ConnectionException,
                                     GetException

Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

lowerWarningFieldLimit

public double lowerWarningFieldLimit()
                              throws ConnectionException,
                                     GetException

Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

upperAlarmFieldLimit

public double upperAlarmFieldLimit()
                            throws ConnectionException,
                                   GetException

Get the field upper settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

lowerAlarmFieldLimit

public double lowerAlarmFieldLimit()
                            throws ConnectionException,
                                   GetException

Get the field lower settable limit of the main power supply in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

getCurrent

public double getCurrent()
                  throws ConnectionException,
                         GetException

Get the main power supply current in this electromagnet via ca (A)

Throws:

ConnectionException

GetException

setCurrent

public void setCurrent(double newCurrent)
                throws ConnectionException,
                       PutException

set the main power supply current in the magnet (A)

Parameters:

newCurrent - is the new current (A)

Throws:

ConnectionException

PutException

upperCurrentLimit

public double upperCurrentLimit()
                         throws ConnectionException,
                                GetException

get the main power supply current lower settable limit (A)

Throws:

ConnectionException

GetException

lowerCurrentLimit

public double lowerCurrentLimit()
                         throws ConnectionException,
                                GetException

get the main power supply current lower settable limit (A)

Throws:

ConnectionException

GetException

isPermanent

public boolean isPermanent()

Since this is an electro-magnet we override the inherited method to advertise this characteristic.

Specified by:

isPermanent in interface MagnetType

Overrides:

isPermanent in class Magnet

Returns:

false since all Electromagnet instances are not permanent magnets.