Package xal.smf.impl

Class BLM

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.BLM

All Implemented Interfaces:

Comparable, ElementType, DataListener

Direct Known Subclasses:

NeutronDetector

public class BLM
extends AcceleratorNode

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

Author:

J. Galambos (jdg@ornl.gov)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOSS_AVG_HANDLE	BLMs official avg channel handle
static final String	LOSS_INT_HANDLE	BLMs official integrated channel handle
final AccessibleProperty	lossAvg
final AccessibleProperty	lossInt
static final String	T_AVG_LEN_HANDLE	BLM official tAvgLen channel handle
final AccessibleProperty	tAvgLen
static final String	TYPE

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

Method Summary

Modifier and Type	Method	Description
double	getLossAvg()	returns average loss
double	getLossInt()	returns integrated loss
double	getTAvgLen()	returns length of the averaged period (micro-sec)
String	getType()	Override to provide type signature

Methods inherited from class xal.smf.AcceleratorNode

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

LOSS_AVG_HANDLE

public static final String LOSS_AVG_HANDLE

BLMs official avg channel handle

See Also:

• Constant Field Values

lossAvg

public final AccessibleProperty lossAvg

LOSS_INT_HANDLE

public static final String LOSS_INT_HANDLE

BLMs official integrated channel handle

See Also:

• Constant Field Values

lossInt

public final AccessibleProperty lossInt

T_AVG_LEN_HANDLE

public static final String T_AVG_LEN_HANDLE

BLM official tAvgLen channel handle

See Also:

• Constant Field Values

tAvgLen

public final AccessibleProperty tAvgLen

Constructor Details

BLM

public BLM(String strId,
 ChannelFactory channelFactory)

Constructor

BLM

public BLM(String strId)

Constructor

Method Details

getType

public String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getLossAvg

public double getLossAvg()
                  throws GetException

returns average loss

Throws:

GetException

getLossInt

public double getLossInt()
                  throws GetException

returns integrated loss

Throws:

GetException

getTAvgLen

public double getTAvgLen()
                  throws GetException

returns length of the averaged period (micro-sec)

Throws:

GetException