Package xal.extension.jels.smf.impl

Class DipoleCorr

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.smf.impl.Dipole

xal.smf.impl.DipoleCorr

xal.extension.jels.smf.impl.DipoleCorr

All Implemented Interfaces:

Comparable, ElementType, MagnetType, DataListener

public class DipoleCorr
extends DipoleCorr

Class for horizontal and vertical correctors.

Author:

Juan F. Esteban Müller <JuanF.EstebanMuller@esss.se>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	standard type for nodes of this class
static final String[]	TYPE_DCH
static final String[]	TYPE_DCV

Fields inherited from class xal.smf.impl.Electromagnet

field, FIELD_RB_HANDLE, fieldFromCurrent, fieldRBProperty, mainSupplyId, useFieldReadback

Fields inherited from class xal.smf.impl.Magnet

bucMagnet

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, 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	Description
DipoleCorr(String strId)
DipoleCorr(String strId, int orientation)
DipoleCorr(String strId, int orientation, ChannelFactory channelFactory)	Primary Constructor
DipoleCorr(String strId, ChannelFactory channelFactory)

Method Summary

Modifier and Type	Method	Description
int	getOrientation()	Get the orientation of the magnet as defined by MagnetType.
String	getType()	Override to provide type signature
boolean	isKindOf(String type)	Determine if a node is of the specified type.
void	setOrientation(int orientation)	Sets orientation of the magnet as defined by MagnetType.

Methods inherited from class xal.smf.impl.DipoleCorr

isCorrector

Methods inherited from class xal.smf.impl.Dipole

getBendAngle, getDfltBendAngle, getDfltPathLength, getEntrRotAngle, getExitRotAngle, getQuadComponent, isPole

Methods inherited from class xal.smf.impl.Electromagnet

findChannel, getAccessibleProperties, getCurrent, getCycleState, getDefaultHandles, getField, getFieldInt, getFieldReadback, getFieldSetting, getHandles, getMainSupply, getReadbackHandles, getSetHandle, getTotalFieldSetting, isChannelSettable, isPermanent, lowerAlarmFieldLimit, lowerCurrentLimit, lowerDisplayFieldLimit, lowerFieldLimit, lowerWarningFieldLimit, setCurrent, setCycleEnable, setField, setMainSupplyId, setUseFieldReadback, toCAFromField, toCurrentFromField, toFieldFromCA, toFieldFromCurrent, update, updatePowerSupplies, upperAlarmFieldLimit, upperCurrentLimit, upperDisplayFieldLimit, upperFieldLimit, upperWarningFieldLimit, useFieldReadback, write, writePowerSupplies

Methods inherited from class xal.smf.impl.Magnet

addBucket, getConversionFactor, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getPolarity, getTangField, isHorizontal, isMagnet, isSkew, isVertical, setDfltField, setMagBucket

Methods inherited from class xal.smf.AcceleratorNode

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, getAccelerator, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, 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 nodes of this class

See Also:

• Constant Field Values

TYPE_DCH

public static final String[] TYPE_DCH

TYPE_DCV

public static final String[] TYPE_DCV

Constructor Details

DipoleCorr

public DipoleCorr(String strId,
 int orientation,
 ChannelFactory channelFactory)

Primary Constructor

DipoleCorr

public DipoleCorr(String strId,
 int orientation)

DipoleCorr

public DipoleCorr(String strId)

DipoleCorr

public DipoleCorr(String strId,
 ChannelFactory channelFactory)

Method Details

getType

public String getType()

Override to provide type signature

Overrides:

getType in class Dipole

setOrientation

public void setOrientation(int orientation)

Sets orientation of the magnet as defined by MagnetType.

Parameters:

orientation - orientation of the magnet, either HORIZONTAL or VERTICAL

getOrientation

public int getOrientation()

Get the orientation of the magnet as defined by MagnetType. The orientation of the dipole is determined by its type: DH or DV

Specified by:

getOrientation in interface MagnetType

Overrides:

getOrientation in class Magnet

Returns:

One of HORIZONTAL or VERTICAL

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.