Package xal.smf.impl

Class EDipole

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Electrostatic

xal.smf.impl.EDipole

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class EDipole
extends Electrostatic

Field Summary

Fields

Modifier and Type	Field	Description
static final int	HORIZONTAL
static final String	HORIZONTAL_TYPE	horizontal dipole type
static final int	NO_ORIENTATION
static final String	TYPE	standard type for instances of this class
static final int	VERTICAL
static final String	VERTICAL_TYPE	vertical dipole type

Fields inherited from class xal.smf.impl.Electrostatic

bucMagnet, field, FIELD_RB_HANDLE, mainSupplyId, useFieldReadback

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, strPId

Constructor Summary

Constructors

Constructor	Description
EDipole(String strId)	Constructor
EDipole(String strId, ChannelFactory channelFactory)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
double	getDfltBendAngle()	Get the dipole bend magnet bending angle.
double	getDfltPathLength()	returns design path length in meters
int	getOrientation()	Get the orientation of the magnet as defined by MagnetType.
String	getType()	Derived class must furnish a unique type id
boolean	isKindOf(String type)	Determine if a node is of the specified type.
void	setType(String newType)
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

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, write, writeAttributes, writeStatus

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

standard type for instances of this class

See Also:

• Constant Field Values

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 String HORIZONTAL_TYPE

horizontal dipole type

See Also:

• Constant Field Values

VERTICAL_TYPE

public static final String VERTICAL_TYPE

vertical dipole type

See Also:

• Constant Field Values

Constructor Details

EDipole

public EDipole(String strId,
 ChannelFactory channelFactory)

Primary Constructor

EDipole

public EDipole(String strId)

Constructor

Method Details

getType

public String getType()

Description copied from class: AcceleratorNode

Derived class must furnish a unique type id

Overrides:

getType in class Electrostatic

setType

public void setType(String newType)

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

getDfltBendAngle

public double getDfltBendAngle()

Get the dipole bend magnet bending angle.

getDfltPathLength

public double getDfltPathLength()

returns design path length in meters

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(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.