gov.sns.xal.smf.impl
Class BLM

java.lang.Object
  |
  +--gov.sns.xal.smf.AcceleratorNode
        |
        +--gov.sns.xal.smf.impl.BLM

All Implemented Interfaces:

DataListener, ElementType

public class BLM

extends AcceleratorNode

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

Field Summary

static java.lang.String	LOSS_AVG_HANDLE BLMs official xAvg channel handle
static java.lang.String	s_strType
static java.lang.String	T_AVG_LEN_HANDLE BLM official tAvgLen channel handle

Fields inherited from class gov.sns.xal.smf.AcceleratorNode

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

Constructor Summary

BLM(java.lang.String strId)

Method Summary

double	getLossAvg() returns average X position over macropulse (mm) accounting for alignment
double	getTAvgLen() returns length of the averaged period (micro-sec)
java.lang.String	getType() Override to provide type signature

Methods inherited from class gov.sns.xal.smf.AcceleratorNode

addBucket, channelSuite, clear, dataLabel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getHandles, getId, getLength, getParent, getPosition, getStatus, getTwiss, getValid, hasBucket, hasParent, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPosition, setStatus, setTwiss, setValid, 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

LOSS_AVG_HANDLE

public static final java.lang.String LOSS_AVG_HANDLE

BLMs official xAvg channel handle

See Also:

Constant Field Values

T_AVG_LEN_HANDLE

public static final java.lang.String T_AVG_LEN_HANDLE

BLM official tAvgLen channel handle

See Also:

Constant Field Values

Constructor Detail

BLM

public BLM(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getLossAvg

public double getLossAvg()
                  throws ConnectionException,
                         GetException

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

ConnectionException

GetException

getTAvgLen

public double getTAvgLen()
                  throws ConnectionException,
                         GetException

returns length of the averaged period (micro-sec)

ConnectionException

GetException