xal.smf.impl

Class Electrostatic

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Electrostatic

All Implemented Interfaces:

ElementType, DataListener

Direct Known Subclasses:

EDipole, EQuad

public class Electrostatic
extends AcceleratorNode

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
static int	HORIZONTAL
protected MagnetBucket	m_bucMagnet The container for the magnet information
protected java.lang.String	mainSupplyId the ID of this magnet's main power supply
static int	NO_ORIENTATION
static int	VERTICAL

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addBucket(AttributeBucket buc) Override AcceleratorNode implementation to check for a MultipoleBucket
double	getDesignField() get the design field for the magnet (T for dipole, T/m for quad, etc.)
double	getDfltField() get the default magnetic field
double	getEffLength() get the effective magnetic length (m)
double	getField() Get the field in this electromagnet via ca.
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.
MagnetBucket	getMagBucket()
MagnetMainSupply	getMainSupply() Get the main power supply for this magnet.
int	getOrientation() Get the orientation of the magnet as defined by MagnetType.
double	getPolarity() get magnet polarity
double	getTotalFieldSetting() Get the value to which the field is set including both the main supply and possible trim supply contributions.
java.lang.String	getType() Derived class must furnish a unique type id
boolean	isHorizontal()
boolean	isVertical()
void	setMagBucket(MagnetBucket buc) Set the attribute bucket containing the machine magnet info
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.
protected void	writePowerSupplies(DataAdaptor powerSupplyAdaptor) Write data to the power supply data adaptor.

Methods inherited from class xal.smf.AcceleratorNode

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

Methods inherited from class java.lang.Object

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

Field Detail

NO_ORIENTATION

public static final int NO_ORIENTATION

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

m_bucMagnet

protected MagnetBucket m_bucMagnet

The container for the magnet information

_useFieldReadback

protected boolean _useFieldReadback

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

FIELD_RB_HANDLE

public static final java.lang.String FIELD_RB_HANDLE

field readback handle

See Also:

Constant Field Values

mainSupplyId

protected java.lang.String mainSupplyId

the ID of this magnet's main power supply

Constructor Detail

Electrostatic

public Electrostatic(java.lang.String strId)

Method Detail

getMagBucket

public MagnetBucket getMagBucket()

Returns:

the attribute bucket containing the machine multipole fields

addBucket

public void addBucket(AttributeBucket buc)

Override AcceleratorNode implementation to check for a MultipoleBucket

Overrides:

addBucket in class AcceleratorNode

setMagBucket

public void setMagBucket(MagnetBucket buc)

Set the attribute bucket containing the machine magnet info

getType

public java.lang.String getType()

Description copied from class: AcceleratorNode

Derived class must furnish a unique type id

Specified by:

getType in class AcceleratorNode

getDesignField

public double getDesignField()

get the design field for the magnet (T for dipole, T/m for quad, etc.)

getEffLength

public double getEffLength()

get the effective magnetic length (m)

getDfltField

public double getDfltField()

get the default magnetic field

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

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

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

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

getMainSupply

public MagnetMainSupply getMainSupply()

Get the main power supply for this magnet.

Returns:

The main power supply for this magnet

getPolarity

public double getPolarity()

get magnet polarity

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

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

getOrientation

public int getOrientation()

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

Returns:

One of HORIZONTAL or VERTICAL

isHorizontal

public boolean isHorizontal()

isVertical

public boolean isVertical()