xal.smf.impl

Class EDipole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Electrostatic

xal.smf.impl.EDipole

All Implemented Interfaces:

ElementType, DataListener

public class EDipole
extends Electrostatic

Field Summary

Fields

Modifier and Type	Field and Description
static int	HORIZONTAL
static java.lang.String	HORIZONTAL_TYPE horizontal dipole type
static int	NO_ORIENTATION
static java.lang.String	s_strType
static int	VERTICAL
static java.lang.String	VERTICAL_TYPE vertical dipole type

Fields inherited from class xal.smf.impl.Electrostatic

_useFieldReadback, FIELD_RB_HANDLE, m_bucMagnet, mainSupplyId

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
EDipole(java.lang.String strId)

Method Summary

Modifier and Type	Method and Description
int	getOrientation() Get the orientation of the magnet as defined by MagnetType.
java.lang.String	getType() Derived class must furnish a unique type id
boolean	isKindOf(java.lang.String type) Determine if a node is of the specified type.
void	update(DataAdaptor adaptor) Update the instance with data from the data adaptor.

Methods inherited from class xal.smf.impl.Electrostatic

addBucket, getDesignField, getDfltField, getEffLength, getField, getFieldReadback, getFieldSetting, getMagBucket, getMainSupply, getPolarity, getTotalFieldSetting, isHorizontal, isVertical, setMagBucket, toCAFromField, toFieldFromCA, writePowerSupplies

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, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

s_strType

public static java.lang.String s_strType

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

HORIZONTAL_TYPE

public static final java.lang.String HORIZONTAL_TYPE

horizontal dipole type

See Also:

Constant Field Values

VERTICAL_TYPE

public static final java.lang.String VERTICAL_TYPE

vertical dipole type

See Also:

Constant Field Values

Constructor Detail

EDipole

public EDipole(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Description copied from class: AcceleratorNode

Derived class must furnish a unique type id

Overrides:

getType in class Electrostatic

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

Overrides:

getOrientation in class Electrostatic

Returns:

One of HORIZONTAL or VERTICAL

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 "QHE" or "QVE".

Specified by:

update in interface DataListener

Overrides:

update in class AcceleratorNode

Parameters:

adaptor - The data provider.

isKindOf

public boolean isKindOf(java.lang.String type)

Description copied from class: AcceleratorNode

Determine if a node is of the specified type. The comparison is based upon the node's class and the element type manager handles checking for inherited classes to types get inherited. Subclasses can override this method if the types comparison is more complicated (e.g. if more than one type can be associated with the same node class).

Specified by:

isKindOf in interface ElementType

Overrides:

isKindOf in class AcceleratorNode

Parameters:

type - The type against which to compare.

Returns:

true if the node is of the specified type; false otherwise.