Package xal.smf.impl

Class RingBPM

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.BPM

xal.smf.impl.RingBPM

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class RingBPM
extends BPM

This class is for SNS Ring BPMs. The Ring BPMs can set up to 4 different gains within its 1060 waveform points. They also have 2 modes: base-band and 402.5 MHz.

Author:

chu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STAGE1_GAIN_HANDLE	BPM stage 1 gain channel handle
static final String	STAGE1_GAIN_RB_HANDLE
static final String	STAGE1_LEN_HANDLE	BPM stage 1 length channel handle
static final String	STAGE1_LEN_RB_HANDLE
static final String	STAGE1_METHOD_HANDLE	BPM stage 1 method channel handle
static final String	STAGE1_METHOD_RB_HANDLE
final AccessibleProperty	stage1Gain
final AccessibleProperty	stage1Len
final AccessibleProperty	stage1Method
static final String	STAGE2_GAIN_HANDLE	BPM stage 2 gain channel handle
static final String	STAGE2_GAIN_RB_HANDLE
static final String	STAGE2_LEN_HANDLE	BPM stage 2 length channel handle
static final String	STAGE2_LEN_RB_HANDLE
static final String	STAGE2_METHOD_HANDLE	BPM stage 2 method channel handle
static final String	STAGE2_METHOD_RB_HANDLE
final AccessibleProperty	stage2Gain
final AccessibleProperty	stage2Len
final AccessibleProperty	stage2Method
static final String	STAGE3_GAIN_HANDLE
static final String	STAGE3_GAIN_RB_HANDLE
static final String	STAGE3_LEN_HANDLE	BPM stage 3 length channel handle
static final String	STAGE3_LEN_RB_HANDLE
static final String	STAGE3_METHOD_HANDLE
static final String	STAGE3_METHOD_RB_HANDLE
final AccessibleProperty	stage3Gain
final AccessibleProperty	stage3Len
final AccessibleProperty	stage3Method
static final String	STAGE4_GAIN_HANDLE	BPM stage 4 gain channel handle
static final String	STAGE4_GAIN_RB_HANDLE
static final String	STAGE4_LEN_HANDLE	BPM stage 4 length channel handle
static final String	STAGE4_LEN_RB_HANDLE
static final String	STAGE4_METHOD_HANDLE	BPM stage 4 method channel handle
static final String	STAGE4_METHOD_RB_HANDLE
final AccessibleProperty	stage4Gain
final AccessibleProperty	stage4Len
final AccessibleProperty	stage4Method
static final String	TYPE

Fields inherited from class xal.smf.impl.BPM

AMP_AVG_HANDLE, AMP_TBT_HANDLE, amplitudeAvg, ampTBT, bpmBucket, PHASE_AVG_HANDLE, PHASE_TBT_HANDLE, phaseAvg, phaseTBT, T_AVG_LEN_HANDLE, tAvgLen, X_AVG_HANDLE, X_TBT_HANDLE, xAvg, xTBT, Y_AVG_HANDLE, Y_TBT_HANDLE, yAvg, 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
RingBPM(String strId)	RingBPM constructor.
RingBPM(String strId, ChannelFactory channelFactory)	RingBPM constructor.

Method Summary

Modifier and Type	Method	Description
int	getStage1Gain()	returns stage 1 gain
int	getStage1Len()	returns stage 1 length
int	getStage1Method()	returns stage 1 method
int	getStage2Gain()	returns stage 2 gain
int	getStage2Len()	returns stage 2 length
int	getStage2Method()	returns stage 2 method
int	getStage3Gain()	returns stage 3 gain
int	getStage3Len()	returns stage 3 length
int	getStage3Method()	returns stage 3 method
int	getStage4Gain()	returns stage 4 gain
int	getStage4Len()	returns stage 4 length
int	getStage4Method()	returns stage 4 method
double	getXAvg(int stage)	returns average X position for a certain stage
double	getYAvg(int stage)	returns average Y position for a certain stage
void	setStage1Gain(long gain)	Set the stage 1 gain.
void	setStage1Len(long len)	Set the stage 1 length.
void	setStage1Method(int method)	Set the stage 1 method.
void	setStage2Gain(long gain)	Set the stage 2 gain.
void	setStage2Len(long len)	Set the stage 2 length.
void	setStage2Method(int method)	Set the stage 2 method.
void	setStage3Gain(long gain)	Set the stage 3 gain.
void	setStage3Len(long len)	Set the stage 3 length.
void	setStage3Method(int method)	Set the stage 3 method.
void	setStage4Gain(long gain)	Set the stage 4 gain.
void	setStage4Len(long len)	Set the stage 4 length.
void	setStage4Method(int method)	Set the stage 4 method.

Methods inherited from class xal.smf.impl.BPM

addBucket, getAmpAvg, getAmpTBT, getBPMBucket, getPhaseAvg, getPhaseTBT, getTAvgLen, getType, getXAvg, getXTBT, getYAvg, getYTBT, setBPMBucket

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

STAGE1_LEN_HANDLE

public static final String STAGE1_LEN_HANDLE

BPM stage 1 length channel handle

See Also:

• Constant Field Values

STAGE1_LEN_RB_HANDLE

public static final String STAGE1_LEN_RB_HANDLE

See Also:

• Constant Field Values

stage1Len

public final AccessibleProperty stage1Len

STAGE1_GAIN_HANDLE

public static final String STAGE1_GAIN_HANDLE

BPM stage 1 gain channel handle

See Also:

• Constant Field Values

STAGE1_GAIN_RB_HANDLE

public static final String STAGE1_GAIN_RB_HANDLE

See Also:

• Constant Field Values

stage1Gain

public final AccessibleProperty stage1Gain

STAGE1_METHOD_HANDLE

public static final String STAGE1_METHOD_HANDLE

BPM stage 1 method channel handle

See Also:

• Constant Field Values

STAGE1_METHOD_RB_HANDLE

public static final String STAGE1_METHOD_RB_HANDLE

See Also:

• Constant Field Values

stage1Method

public final AccessibleProperty stage1Method

STAGE2_LEN_HANDLE

public static final String STAGE2_LEN_HANDLE

BPM stage 2 length channel handle

See Also:

• Constant Field Values

STAGE2_LEN_RB_HANDLE

public static final String STAGE2_LEN_RB_HANDLE

See Also:

• Constant Field Values

stage2Len

public final AccessibleProperty stage2Len

STAGE2_GAIN_HANDLE

public static final String STAGE2_GAIN_HANDLE

BPM stage 2 gain channel handle

See Also:

• Constant Field Values

STAGE2_GAIN_RB_HANDLE

public static final String STAGE2_GAIN_RB_HANDLE

See Also:

• Constant Field Values

stage2Gain

public final AccessibleProperty stage2Gain

STAGE2_METHOD_HANDLE

public static final String STAGE2_METHOD_HANDLE

BPM stage 2 method channel handle

See Also:

• Constant Field Values

STAGE2_METHOD_RB_HANDLE

public static final String STAGE2_METHOD_RB_HANDLE

See Also:

• Constant Field Values

stage2Method

public final AccessibleProperty stage2Method

STAGE3_LEN_HANDLE

public static final String STAGE3_LEN_HANDLE

BPM stage 3 length channel handle

See Also:

• Constant Field Values

STAGE3_LEN_RB_HANDLE

public static final String STAGE3_LEN_RB_HANDLE

See Also:

• Constant Field Values

stage3Len

public final AccessibleProperty stage3Len

STAGE3_GAIN_HANDLE

public static final String STAGE3_GAIN_HANDLE

See Also:

• Constant Field Values

STAGE3_GAIN_RB_HANDLE

public static final String STAGE3_GAIN_RB_HANDLE

See Also:

• Constant Field Values

stage3Gain

public final AccessibleProperty stage3Gain

STAGE3_METHOD_HANDLE

public static final String STAGE3_METHOD_HANDLE

See Also:

• Constant Field Values

STAGE3_METHOD_RB_HANDLE

public static final String STAGE3_METHOD_RB_HANDLE

See Also:

• Constant Field Values

stage3Method

public final AccessibleProperty stage3Method

STAGE4_LEN_HANDLE

public static final String STAGE4_LEN_HANDLE

BPM stage 4 length channel handle

See Also:

• Constant Field Values

STAGE4_LEN_RB_HANDLE

public static final String STAGE4_LEN_RB_HANDLE

See Also:

• Constant Field Values

stage4Len

public final AccessibleProperty stage4Len

STAGE4_GAIN_HANDLE

public static final String STAGE4_GAIN_HANDLE

BPM stage 4 gain channel handle

See Also:

• Constant Field Values

STAGE4_GAIN_RB_HANDLE

public static final String STAGE4_GAIN_RB_HANDLE

See Also:

• Constant Field Values

stage4Gain

public final AccessibleProperty stage4Gain

STAGE4_METHOD_HANDLE

public static final String STAGE4_METHOD_HANDLE

BPM stage 4 method channel handle

See Also:

• Constant Field Values

STAGE4_METHOD_RB_HANDLE

public static final String STAGE4_METHOD_RB_HANDLE

See Also:

• Constant Field Values

stage4Method

public final AccessibleProperty stage4Method

Constructor Details

RingBPM

public RingBPM(String strId,
 ChannelFactory channelFactory)

RingBPM constructor.

RingBPM

public RingBPM(String strId)

RingBPM constructor.

Method Details

getStage1Len

public int getStage1Len()
                 throws GetException

returns stage 1 length

Throws:

GetException

getStage1Gain

public int getStage1Gain()
                  throws GetException

returns stage 1 gain

Throws:

GetException

getStage1Method

public int getStage1Method()
                    throws GetException

returns stage 1 method

Throws:

GetException

getStage2Len

public int getStage2Len()
                 throws GetException

returns stage 2 length

Throws:

GetException

getStage2Gain

public int getStage2Gain()
                  throws GetException

returns stage 2 gain

Throws:

GetException

getStage2Method

public int getStage2Method()
                    throws GetException

returns stage 2 method

Throws:

GetException

getStage3Len

public int getStage3Len()
                 throws GetException

returns stage 3 length

Throws:

GetException

getStage3Gain

public int getStage3Gain()
                  throws GetException

returns stage 3 gain

Throws:

GetException

getStage3Method

public int getStage3Method()
                    throws GetException

returns stage 3 method

Throws:

GetException

getStage4Len

public int getStage4Len()
                 throws GetException

returns stage 4 length

Throws:

GetException

getStage4Gain

public int getStage4Gain()
                  throws GetException

returns stage 4 gain

Throws:

GetException

getStage4Method

public int getStage4Method()
                    throws GetException

returns stage 4 method

Throws:

GetException

setStage1Len

public void setStage1Len(long len)
                  throws PutException

Set the stage 1 length.

Parameters:

len - The stage length

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage2Len

public void setStage2Len(long len)
                  throws PutException

Set the stage 2 length.

Parameters:

len - The stage length

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage3Len

public void setStage3Len(long len)
                  throws PutException

Set the stage 3 length.

Parameters:

len - The stage length

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage4Len

public void setStage4Len(long len)
                  throws PutException

Set the stage 4 length.

Parameters:

len - The stage length

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage1Gain

public void setStage1Gain(long gain)
                   throws PutException

Set the stage 1 gain.

Parameters:

gain - The stage gain

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage2Gain

public void setStage2Gain(long gain)
                   throws PutException

Set the stage 2 gain.

Parameters:

gain - The stage gain

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage3Gain

public void setStage3Gain(long gain)
                   throws PutException

Set the stage 3 gain.

Parameters:

gain - The stage gain

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage4Gain

public void setStage4Gain(long gain)
                   throws PutException

Set the stage 4 gain.

Parameters:

gain - The stage gain

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage1Method

public void setStage1Method(int method)
                     throws PutException

Set the stage 1 method.

Parameters:

method - The stage method

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage2Method

public void setStage2Method(int method)
                     throws PutException

Set the stage 2 method.

Parameters:

method - The stage method

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage3Method

public void setStage3Method(int method)
                     throws PutException

Set the stage 3 method.

Parameters:

method - The stage method

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

setStage4Method

public void setStage4Method(int method)
                     throws PutException

Set the stage 4 method.

Parameters:

method - The stage method

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

getXAvg

public double getXAvg(int stage)
               throws GetException

returns average X position for a certain stage

Parameters:

stage - stage number

Throws:

GetException

getYAvg

public double getYAvg(int stage)
               throws GetException

returns average Y position for a certain stage

Parameters:

stage - stage number

Throws:

GetException