xal.smf.impl

Class Quadrupole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Quadrupole

All Implemented Interfaces:

ElementType, MagnetType, DataListener

Direct Known Subclasses:

TrimmedQuadrupole

public class Quadrupole
extends Electromagnet

Quadrupole implements an Electromagnet Quadrupole supplied by a single power supply. Unlike many other beam line elements, Quadrupole represents more than one official type (QH and QV) as specified by the naming convention. In order to support this feature we override the getType(), update() and isKindOf() methods. The vertical and horizontal reference to a quadrapole isn't of consequence to behavior since the field of the quadrupole (including its sign) and its length characterizes the quadrupole.

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	_type the type of quadrupole (horizontal or vertical)
static java.lang.String	HORIZONTAL_TYPE horizontal quadrupole type
static java.lang.String	s_strType
static java.lang.String	SKEW_TYPE skew quadrupole type
static java.lang.String	VERTICAL_TYPE vertical quadrupole 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
Quadrupole(java.lang.String strID) Constructor

Method Summary

Modifier and Type	Method and Description
int	getOrientation() Get the orientation of the magnet as defined by MagnetType.
java.lang.String	getType() Override to provide the correct type signature per instance.
boolean	isKindOf(java.lang.String type) Determine if this node is of the specified type.
boolean	isPole(java.lang.String compPole) Determine whether this magnet is of the pole specified.
void	update(DataAdaptor adaptor) Update the instance with data from the data adaptor.

Methods inherited from class xal.smf.impl.Electromagnet

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

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

horizontal quadrupole type

See Also:

Constant Field Values

VERTICAL_TYPE

public static final java.lang.String VERTICAL_TYPE

vertical quadrupole type

See Also:

Constant Field Values

SKEW_TYPE

public static final java.lang.String SKEW_TYPE

skew quadrupole type

See Also:

Constant Field Values

_type

protected java.lang.String _type

the type of quadrupole (horizontal or vertical)

Constructor Detail

Quadrupole

public Quadrupole(java.lang.String strID)

Constructor

Parameters:

strID - the unique node identifier

Method Detail

getType

public java.lang.String getType()

Override to provide the correct type signature per instance. This is necessary since the Quadrupole class can represent more than one official type (QH or QV).

Specified by:

getType in class AcceleratorNode

Returns:

The official type consistent with the naming convention.

update

public void update(DataAdaptor adaptor)

Update the instance with data from the data adaptor. Overrides the default implementation to set the quadrupole type since a quadrupole type can be either "QH" or "QV".

Specified by:

update in interface DataListener

Overrides:

update in class Electromagnet

Parameters:

adaptor - The data provider.

isPole

public boolean isPole(java.lang.String compPole)

Determine whether this magnet is of the pole specified.

Specified by:

isPole in interface MagnetType

Overrides:

isPole in class Magnet

Parameters:

compPole - The pole against which this magnet is being compared.

Returns:

true if this magnet matches the specified pole.

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

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Magnet

Returns:

One of HORIZONTAL or VERTICAL

isKindOf

public boolean isKindOf(java.lang.String type)

Determine if this node is of the specified type. Override the default method since a quadrupole could represent either a vertical or horizontal type. Must also handle inheritance checking so we must or the direct type comparison with the inherited type checking.

Specified by:

isKindOf in interface ElementType

Overrides:

isKindOf in class AcceleratorNode

Parameters:

type - The type against which to compare this quadrupole's type.

Returns:

true if the node is a match and false otherwise.