Package xal.extension.jels.smf.impl

Class MagFieldMap

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.Magnet

xal.smf.impl.Electromagnet

xal.extension.jels.smf.impl.MagFieldMap

All Implemented Interfaces:

Comparable, IFileBasedFieldMap, ElementType, MagnetType, ISplittable, DataListener

public class MagFieldMap
extends Electromagnet
implements ISplittable, IFileBasedFieldMap

General magnetic Field Map element. It can be used with any type of FieldMap objects.

This element has to buckets:

• MagBucket: contains magnetic field parameters.
• FieldMapBucket: includes the filename of the field map file and information about its type.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldMapBucket	bucFieldMap
static final String	TYPE

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
MagFieldMap(String strId)
MagFieldMap(String strId, ChannelFactory channelFactory)

Method Summary

Modifier and Type	Method	Description
void	addBucket(AttributeBucket buc)	Override AcceleratorNode implementation to check for a FieldMapBucket
FieldMap	getFieldMap()
FieldMapBucket	getFieldMapBucket()
String	getFieldMapFile()
double[]	getLongitudinalPositions()
double	getSliceLength()
String	getType()	Derived class must furnish a unique type id
void	setDimensions(int i)
void	setDynamic(boolean b)
void	setFieldMap(FieldMap fieldMap)
final void	setFieldMapBucket(FieldMapBucket buc)
void	setFieldMapFile(String strVal)
void	update(DataAdaptor adaptor)	Update the node with data from the provided adaptor.
void	writeFieldMap(String fieldMapPath)	Write the field map to a file.

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, updatePowerSupplies, upperAlarmFieldLimit, upperCurrentLimit, upperDisplayFieldLimit, upperFieldLimit, upperWarningFieldLimit, useFieldReadback, write, writePowerSupplies

Methods inherited from class xal.smf.impl.Magnet

getConversionFactor, getDesignField, getDfltField, getEffLength, getMagBucket, getNormField, getOrientation, getPolarity, getTangField, isCorrector, isHorizontal, isMagnet, isPole, 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, isKindOf, 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

Methods inherited from interface xal.smf.impl.qualify.ElementType

isKindOf

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

bucFieldMap

protected FieldMapBucket bucFieldMap

Constructor Details

MagFieldMap

public MagFieldMap(String strId)

MagFieldMap

public MagFieldMap(String strId,
 ChannelFactory channelFactory)

Method Details

getType

public String getType()

Description copied from class: AcceleratorNode

Derived class must furnish a unique type id

Specified by:

getType in class AcceleratorNode

getFieldMapBucket

public FieldMapBucket getFieldMapBucket()

setFieldMapBucket

public final void setFieldMapBucket(FieldMapBucket buc)

addBucket

public void addBucket(AttributeBucket buc)

Override AcceleratorNode implementation to check for a FieldMapBucket

Overrides:

addBucket in class Magnet

Parameters:

buc -

getFieldMapFile

public String getFieldMapFile()

Returns:

FieldMap file

setFieldMapFile

public void setFieldMapFile(String strVal)

Parameters:

strVal - FieldMap file

getFieldMap

public FieldMap getFieldMap()

Returns:

Field profile

setFieldMap

public void setFieldMap(FieldMap fieldMap)

Parameters:

fieldMap -

update

public void update(DataAdaptor adaptor)

Description copied from class: Electromagnet

Update the node with data from the provided adaptor.

Specified by:

update in interface DataListener

Overrides:

update in class Electromagnet

Parameters:

adaptor - The data provider

getLongitudinalPositions

public double[] getLongitudinalPositions()

Specified by:

getLongitudinalPositions in interface ISplittable

Returns:

Longitudinal positions at which the element must be split.

getSliceLength

public double getSliceLength()

Specified by:

getSliceLength in interface ISplittable

Returns:

Length of each slice of the element.

setDimensions

public void setDimensions(int i)

setDynamic

public void setDynamic(boolean b)

writeFieldMap

public void writeFieldMap(String fieldMapPath)

Description copied from interface: IFileBasedFieldMap

Write the field map to a file.

Specified by:

writeFieldMap in interface IFileBasedFieldMap

Parameters:

fieldMapPath - The path to the directory where field map should be saved.