xal.smf.impl

Class Sextupole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Sextupole

All Implemented Interfaces:

ElementType, MagnetType, DataListener

public class Sextupole
extends Electromagnet

Sextupole magnet node.

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 identifies the type of sextupole (horizontal, vertical, skew)
static java.lang.String	HORIZONTAL_SKEW_TYPE
static java.lang.String	HORIZONTAL_TYPE
static java.lang.String	s_strType
static java.lang.String	VERTICAL_SKEW_TYPE
static java.lang.String	VERTICAL_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
Sextupole(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 pole) Test if the magnet is of the specified pole type.
boolean	isSkew() Determine whether this magnet is a skew magnet.
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, 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

HORIZONTAL_SKEW_TYPE

public static final java.lang.String HORIZONTAL_SKEW_TYPE

See Also:

Constant Field Values

VERTICAL_SKEW_TYPE

public static final java.lang.String VERTICAL_SKEW_TYPE

See Also:

Constant Field Values

_type

protected java.lang.String _type

identifies the type of sextupole (horizontal, vertical, skew)

Constructor Detail

Sextupole

public Sextupole(java.lang.String strID)

Constructor

Parameters:

strID - unique node ID

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 (SH or SV).

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 sextupole type since a sextupole type can be one of "SH", "SV", "SSH" or "SSV".

Specified by:

update in interface DataListener

Overrides:

update in class Electromagnet

Parameters:

adaptor - The data provider.

isPole

public boolean isPole(java.lang.String pole)

Description copied from class: Magnet

Test if the magnet is of the specified pole type. MagnetType defines the list of accepted pole types.

Specified by:

isPole in interface MagnetType

Overrides:

isPole in class Magnet

Parameters:

pole - Comparison pole which should be one of MagnetType.poles

Returns:

true if the magnet is of the specified pole.

getOrientation

public int getOrientation()

Get the orientation of the magnet as defined by MagnetType. The orientation of the sextupole is determined by its type.

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Magnet

Returns:

One of HORIZONTAL or VERTICAL

isSkew

public boolean isSkew()

Determine whether this magnet is a skew magnet.

Specified by:

isSkew in interface MagnetType

Overrides:

isSkew in class Magnet

Returns:

true if the magnet is skew and false otherwise.

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 sextupole

Returns:

true if the node is a match and false otherwise.