Package xal.extension.jels.smf.impl

Class RfFieldMap

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.RfGap

xal.extension.jels.smf.impl.RfFieldMap

All Implemented Interfaces:

Comparable, IFileBasedFieldMap, ElementType, ISplittable, DataListener

public class RfFieldMap
extends RfGap
implements ISplittable, IFileBasedFieldMap

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

This element has to buckets:

• RFGap: contains rf 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.RfGap

bucRfGap

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
RfFieldMap(String strId)
RfFieldMap(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()	Override to provide type signature
void	setDimensions(int i)
void	setDynamic(boolean b)
void	setFieldMap(FieldMap fieldMap)
final void	setFieldMapBucket(FieldMapBucket buc)
void	setFieldMapFile(String strVal)
double	toE0TLFromGapField(double field)	Convert RF gap field, E0, to E0TL.
void	update(DataAdaptor adaptor)	Loads the field profile if necessary
void	writeFieldMap(String fieldMapPath)	Write the field map to a file.

Methods inherited from class xal.smf.impl.RfGap

getDesignEnergyGain, getGapAmpAvg, getGapDfltAmp, getGapDfltE0TL, getGapDfltFrequency, getGapDfltPhase, getGapE0TL, getGapLength, getGapOffset, getGapPhaseAvg, getGapTTF, getRfGap, getSFit, getSPrimeFit, getStructureMode, getTTFFit, getTTFPrimeFit, isEndCell, isFirstCell, setFirstCell, setGapAmp, setGapPhase, setGapTTF, setRfGap, toGapAmpFromCavityAmp, toGapPhaseFromCavityPhase

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, isKindOf, 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

See Also:

• Constant Field Values

bucFieldMap

protected FieldMapBucket bucFieldMap

Constructor Details

RfFieldMap

public RfFieldMap(String strId)

RfFieldMap

public RfFieldMap(String strId,
 ChannelFactory channelFactory)

Method Details

getType

public String getType()

Description copied from class: RfGap

Override to provide type signature

Overrides:

getType in class RfGap

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 RfGap

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 -

toE0TLFromGapField

public double toE0TLFromGapField(double field)

Description copied from class: RfGap

Convert RF gap field, E0, to E0TL. This is the product of the field * gap length * TTF.

Overrides:

toE0TLFromGapField in class RfGap

Parameters:

field - the RF field in KV/m

Returns:

the E0TL product (kV)

update

public void update(DataAdaptor adaptor)

Loads the field profile if necessary

Specified by:

update in interface DataListener

Overrides:

update in class AcceleratorNode

Parameters:

adaptor -

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.