xal.smf.impl

Class TrimmedQuadrupole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Quadrupole

xal.smf.impl.TrimmedQuadrupole

All Implemented Interfaces:

ElementType, MagnetType, TrimmedMagnet, DataListener

public class TrimmedQuadrupole
extends Quadrupole
implements TrimmedMagnet

TrimmedQuadrupole is a subclass of Quadrupole that has a trim power supply in addition to a main power supply.

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.impl.Electromagnet

Electromagnet.Property

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_trimSupplyID unique ID for this magnet's trim supply
static java.lang.String	HORIZONTAL_TYPE
static java.lang.String	s_strType
static java.lang.String	VERTICAL_TYPE

Fields inherited from class xal.smf.impl.Quadrupole

_type, SKEW_TYPE

Fields inherited from class xal.smf.impl.Electromagnet

_useFieldReadback, FIELD_RB_HANDLE, mainSupplyId

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
TrimmedQuadrupole(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 checking the trim supply if the channel suite or main supply does not contain the handle
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()
int	getOrientation() Get the orientation of the magnet as defined by MagnetType.
double	getTotalFieldSetting() Get the value to which the field is set including both the main supply and trim supply contributions.
double	getTrimCurrent() Get the trim power supply current in this electromagnet via ca (A)
double	getTrimFieldSetting() Get the value to which the trim supply's field contribution is set.
MagnetTrimSupply	getTrimSupply() Get the trim power supply for this magnet.
void	setTrimCurrent(double newCurrent) set the trim power supply current in the magnet (A)
void	setTrimField(double newField) Set the trim power supply field contribution in the magnet.
protected void	updatePowerSupplies(DataAdaptor powerSupplyAdaptor) Update data from the power supply data adaptor.
protected void	writePowerSupplies(DataAdaptor powerSupplyAdaptor) Write data to the power supply data adaptor.

Methods inherited from class xal.smf.impl.Quadrupole

getType, isKindOf, isPole, update

Methods inherited from class xal.smf.impl.Electromagnet

getCurrent, getCycleState, getDesignPropertyValue, getField, getFieldInt, getFieldReadback, getFieldSetting, getMainSupply, isPermanent, lowerAlarmFieldLimit, lowerCurrentLimit, lowerDisplayFieldLimit, lowerFieldLimit, lowerWarningFieldLimit, setCurrent, setCycleEnable, setField, setUseFieldReadback, toCAFromField, toFieldFromCA, upperAlarmFieldLimit, upperCurrentLimit, upperDisplayFieldLimit, upperFieldLimit, upperWarningFieldLimit, useFieldReadback, write

Methods inherited from class xal.smf.impl.Magnet

addBucket, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getPolarity, getTangField, isCorrector, isHorizontal, isMagnet, 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, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, 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

Field Detail

s_strType

public static final java.lang.String s_strType

See Also:

Constant Field Values

HORIZONTAL_TYPE

public static final java.lang.String HORIZONTAL_TYPE

See Also:

Constant Field Values

VERTICAL_TYPE

public static final java.lang.String VERTICAL_TYPE

See Also:

Constant Field Values

_trimSupplyID

protected java.lang.String _trimSupplyID

unique ID for this magnet's trim supply

Constructor Detail

TrimmedQuadrupole

public TrimmedQuadrupole(java.lang.String strID)

Constructor

Parameters:

strID - this magnet's unique node ID

Method Detail

updatePowerSupplies

protected void updatePowerSupplies(DataAdaptor powerSupplyAdaptor)

Update data from the power supply data adaptor.

Overrides:

updatePowerSupplies in class Electromagnet

Parameters:

powerSupplyAdaptor - The data provider of power supply information.

writePowerSupplies

protected void writePowerSupplies(DataAdaptor powerSupplyAdaptor)

Write data to the power supply data adaptor.

Overrides:

writePowerSupplies in class Electromagnet

Parameters:

powerSupplyAdaptor - The data sink for the power supply information

getHandles

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

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

Overrides:

getHandles in class Electromagnet

Returns:

The channel handles associated with this node

findChannel

public Channel findChannel(java.lang.String handle)

Find the channel for the specified handle checking the trim supply if the channel suite or main supply does not contain the handle

Overrides:

findChannel in class Electromagnet

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.

getTrimSupply

public MagnetTrimSupply getTrimSupply()

Get the trim power supply for this magnet.

Specified by:

getTrimSupply in interface TrimmedMagnet

Returns:

The trim power supply for this magnet

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 Electromagnet

getLivePropertyChannels

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

Get the array of channels for the specified property

Overrides:

getLivePropertyChannels in class Electromagnet

setTrimField

public void setTrimField(double newField)
                  throws ConnectionException,
                         PutException

Set the trim 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

getTrimFieldSetting

public double getTrimFieldSetting()
                           throws ConnectionException,
                                  GetException

Get the value to which the trim 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 trim supply contributions. Note that this is not the readback.

Overrides:

getTotalFieldSetting in class Electromagnet

Returns:

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

Throws:

ConnectionException

GetException

getTrimCurrent

public double getTrimCurrent()
                      throws ConnectionException,
                             GetException

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

Throws:

ConnectionException

GetException

setTrimCurrent

public void setTrimCurrent(double newCurrent)
                    throws ConnectionException,
                           PutException

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

Parameters:

newCurrent - is the new current (A)

Throws:

ConnectionException

PutException

getOrientation

public int getOrientation()

Get the orientation of the magnet as defined by MagnetType. The orientation of the quad is determined by its type: QTH or QTV

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Quadrupole

Returns:

One of HORIZONTAL or VERTICAL