xal.smf.impl

Class BPM

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.BPM

All Implemented Interfaces:

ElementType, DataListener

Direct Known Subclasses:

RingBPM

public class BPM
extends AcceleratorNode

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMP_AVG_HANDLE BPMs official ampAvg channel handle
static java.lang.String	AMP_TBT_HANDLE BPMs official amplitude turn-by-turn channel handle
double[]	ampTBT the measured amplitude array, minipulse by minipulse (au)
protected BPMBucket	bpmBucket The container for the bpm information
static java.lang.String	PHASE_AVG_HANDLE BPMs official phaseAvg channel handle
static java.lang.String	PHASE_TBT_HANDLE BPMs official phase turn-by-turn channel handle
double[]	phaseTBT the measured phase array, minipulse by minipulse (deg)
static java.lang.String	s_strType
static java.lang.String	T_AVG_LEN_HANDLE BPM official tAvgLen channel handle
static java.lang.String	X_AVG_HANDLE BPMs official xAvg channel handle
static java.lang.String	X_TBT_HANDLE BPMs official x turn-by-turn channel handle
double[]	xTBT the measured horizontal (x) position array, minipulse by minipulse (m)
static java.lang.String	Y_AVG_HANDLE BPMs official yAvg channel handle
static java.lang.String	Y_TBT_HANDLE BPMs official y turn-by-turn channel handle
double[]	yTBT the measured vertical (y) position array, minipulse by minipulse (m)

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Constructor Summary

Constructors

Constructor and Description
BPM(java.lang.String strId)

Method Summary

Modifier and Type	Method and 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() returnthe 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)
java.lang.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

channelSuite, clear, dataLabel, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString, update, write

Methods inherited from class java.lang.Object

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

Field Detail

s_strType

public static final java.lang.String s_strType

See Also:

Constant Field Values

bpmBucket

protected BPMBucket bpmBucket

The container for the bpm information

X_AVG_HANDLE

public static final java.lang.String X_AVG_HANDLE

BPMs official xAvg channel handle

See Also:

Constant Field Values

Y_AVG_HANDLE

public static final java.lang.String Y_AVG_HANDLE

BPMs official yAvg channel handle

See Also:

Constant Field Values

AMP_AVG_HANDLE

public static final java.lang.String AMP_AVG_HANDLE

BPMs official ampAvg channel handle

See Also:

Constant Field Values

PHASE_AVG_HANDLE

public static final java.lang.String PHASE_AVG_HANDLE

BPMs official phaseAvg channel handle

See Also:

Constant Field Values

X_TBT_HANDLE

public static final java.lang.String X_TBT_HANDLE

BPMs official x turn-by-turn channel handle

See Also:

Constant Field Values

Y_TBT_HANDLE

public static final java.lang.String Y_TBT_HANDLE

BPMs official y turn-by-turn channel handle

See Also:

Constant Field Values

AMP_TBT_HANDLE

public static final java.lang.String AMP_TBT_HANDLE

BPMs official amplitude turn-by-turn channel handle

See Also:

Constant Field Values

PHASE_TBT_HANDLE

public static final java.lang.String PHASE_TBT_HANDLE

BPMs official phase turn-by-turn channel handle

See Also:

Constant Field Values

T_AVG_LEN_HANDLE

public static final java.lang.String T_AVG_LEN_HANDLE

BPM official tAvgLen channel handle

See Also:

Constant Field Values

xTBT

public double[] xTBT

the measured horizontal (x) position array, minipulse by minipulse (m)

yTBT

public double[] yTBT

the measured vertical (y) position array, minipulse by minipulse (m)

ampTBT

public double[] ampTBT

the measured amplitude array, minipulse by minipulse (au)

phaseTBT

public double[] phaseTBT

the measured phase array, minipulse by minipulse (deg)

Constructor Detail

BPM

public BPM(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getBPMBucket

public BPMBucket getBPMBucket()

returnthe 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 ConnectionException,
                      GetException

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

Throws:

ConnectionException

GetException

getYAvg

public double getYAvg()
               throws ConnectionException,
                      GetException

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

Throws:

ConnectionException

GetException

getAmpAvg

public double getAmpAvg()
                 throws ConnectionException,
                        GetException

returns average bpm Amplitude signal over macropulse (au)

Throws:

ConnectionException

GetException

getPhaseAvg

public double getPhaseAvg()
                   throws ConnectionException,
                          GetException

returns average bpm phase signal over macropulse (au)

Throws:

ConnectionException

GetException

getXTBT

public double[] getXTBT()
                 throws ConnectionException,
                        GetException

returns bpm x turn-by-turn array

Throws:

ConnectionException

GetException

getYTBT

public double[] getYTBT()
                 throws ConnectionException,
                        GetException

returns bpm y turn-by-turn array

Throws:

ConnectionException

GetException

getAmpTBT

public double[] getAmpTBT()
                   throws ConnectionException,
                          GetException

returns bpm amplitude turn-by-turn array

Throws:

ConnectionException

GetException

getPhaseTBT

public double[] getPhaseTBT()
                     throws ConnectionException,
                            GetException

returns bpm phase turn-by-turn array

Throws:

ConnectionException

GetException

getTAvgLen

public double getTAvgLen()
                  throws ConnectionException,
                         GetException

returns length of the averaged period (micro-sec)

Throws:

ConnectionException

GetException