Package xal.smf.impl

Class BPM

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.BPM

All Implemented Interfaces:

Comparable, ElementType, DataListener

Direct Known Subclasses:

NPM, RingBPM

public class BPM
extends AcceleratorNode

The implementation of the BPM class. This class contains the methods members, attributes, and signal sets pertinent to modeling Beam Position monitors.

Author:

J. Galambos (jdg@ornl.gov)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMP_AVG_HANDLE
static final String	AMP_TBT_HANDLE
final AccessibleProperty	amplitudeAvg
final AccessibleProperty	ampTBT
protected BPMBucket	bpmBucket	The container for the bpm information
static final String	PHASE_AVG_HANDLE
static final String	PHASE_TBT_HANDLE
final AccessibleProperty	phaseAvg
final AccessibleProperty	phaseTBT
static final String	T_AVG_LEN_HANDLE
final AccessibleProperty	tAvgLen
static final String	TYPE
static final String	X_AVG_HANDLE
static final String	X_TBT_HANDLE
final AccessibleProperty	xAvg
final AccessibleProperty	xTBT
static final String	Y_AVG_HANDLE
static final String	Y_TBT_HANDLE
final AccessibleProperty	yAvg
final AccessibleProperty	yTBT

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

Method Summary

Modifier and Type	Method	Description
void	addBucket(AttributeBucket buc)	Override AcceleratorNode implementation to check for a BPMBucket
double	getAmpAvg()	returns average bpm Amplitude signal over macropulse (au)
double[]	getAmpTBT()	returns bpm amplitude turn-by-turn array
BPMBucket	getBPMBucket()	return the BPM Bucket
double	getPhaseAvg()	returns average bpm phase signal over macropulse (au)
double[]	getPhaseTBT()	returns bpm phase turn-by-turn array
double	getTAvgLen()	returns length of the averaged period (micro-sec)
String	getType()	Override to provide type signature
double	getXAvg()	returns average X position over macropulse (mm) accounting for alignment
double[]	getXTBT()	returns bpm x turn-by-turn array
double	getYAvg()	returns average Y position over macropulse (mm) accounting for alignment
double[]	getYTBT()	returns bpm y turn-by-turn array
void	setBPMBucket(BPMBucket buc)	Set the attribute bucket containing the bpm info

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

bpmBucket

protected BPMBucket bpmBucket

The container for the bpm information

X_AVG_HANDLE

public static final String X_AVG_HANDLE

See Also:

• Constant Field Values

xAvg

public final AccessibleProperty xAvg

Y_AVG_HANDLE

public static final String Y_AVG_HANDLE

See Also:

• Constant Field Values

yAvg

public final AccessibleProperty yAvg

AMP_AVG_HANDLE

public static final String AMP_AVG_HANDLE

See Also:

• Constant Field Values

amplitudeAvg

public final AccessibleProperty amplitudeAvg

PHASE_AVG_HANDLE

public static final String PHASE_AVG_HANDLE

See Also:

• Constant Field Values

phaseAvg

public final AccessibleProperty phaseAvg

X_TBT_HANDLE

public static final String X_TBT_HANDLE

See Also:

• Constant Field Values

xTBT

public final AccessibleProperty xTBT

Y_TBT_HANDLE

public static final String Y_TBT_HANDLE

See Also:

• Constant Field Values

yTBT

public final AccessibleProperty yTBT

AMP_TBT_HANDLE

public static final String AMP_TBT_HANDLE

See Also:

• Constant Field Values

ampTBT

public final AccessibleProperty ampTBT

PHASE_TBT_HANDLE

public static final String PHASE_TBT_HANDLE

See Also:

• Constant Field Values

phaseTBT

public final AccessibleProperty phaseTBT

T_AVG_LEN_HANDLE

public static final String T_AVG_LEN_HANDLE

See Also:

• Constant Field Values

tAvgLen

public final AccessibleProperty tAvgLen

Constructor Details

BPM

public BPM(String strId,
 ChannelFactory channelFactory)

Constructor

BPM

public BPM(String strId)

Constructor

Method Details

getType

public String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getBPMBucket

public BPMBucket getBPMBucket()

return the BPM Bucket

setBPMBucket

public void setBPMBucket(BPMBucket buc)

Set the attribute bucket containing the bpm info

addBucket

public void addBucket(AttributeBucket buc)

Override AcceleratorNode implementation to check for a BPMBucket

Overrides:

addBucket in class AcceleratorNode

getXAvg

public double getXAvg()
               throws GetException

returns average X position over macropulse (mm) accounting for alignment

Throws:

GetException

getYAvg

public double getYAvg()
               throws GetException

returns average Y position over macropulse (mm) accounting for alignment

Throws:

GetException

getAmpAvg

public double getAmpAvg()
                 throws GetException

returns average bpm Amplitude signal over macropulse (au)

Throws:

GetException

getPhaseAvg

public double getPhaseAvg()
                   throws GetException

returns average bpm phase signal over macropulse (au)

Throws:

GetException

getXTBT

public double[] getXTBT()
                 throws GetException

returns bpm x turn-by-turn array

Throws:

GetException

getYTBT

public double[] getYTBT()
                 throws GetException

returns bpm y turn-by-turn array

Throws:

GetException

getAmpTBT

public double[] getAmpTBT()
                   throws GetException

returns bpm amplitude turn-by-turn array

Throws:

GetException

getPhaseTBT

public double[] getPhaseTBT()
                     throws GetException

returns bpm phase turn-by-turn array

Throws:

GetException

getTAvgLen

public double getTAvgLen()
                  throws GetException

returns length of the averaged period (micro-sec)

Throws:

GetException