xal.smf.impl

Class CurrentMonitor

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.CurrentMonitor

All Implemented Interfaces:

ElementType, DataListener

public class CurrentMonitor
extends AcceleratorNode

The implementation of the Current Monitor class. This class contains the methods members, attributes, and signal sets pertinant to modeling Current Monitors.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	I_AVG_HANDLE
static java.lang.String	I_MAX_HANDLE
static java.lang.String	I_TBT_HANDLE
static java.lang.String	Q_INTEGRAL_HANDLE
static java.lang.String	s_strType
static java.lang.String	T_AVG_LEN_HANDLE
static java.lang.String	T_DELAY_HANDLE

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
CurrentMonitor(java.lang.String strId)

Method Summary

Modifier and Type	Method and Description
double	getIAvg() Avgerage beam current
double	getIMax() Maximum beam current
double[]	getITBT() Turn by turn current
double[]	getITBTWithBeamOnly() Get the portion of ITBT array with beam on only.
double	getQIntegral() Integrated current over macropulse
double	getTAvgLen() Averaged pulse length
double	getTDelay() Time delay
java.lang.String	getType() Override to provide type signature

Methods inherited from class xal.smf.AcceleratorNode

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

Q_INTEGRAL_HANDLE

public static final java.lang.String Q_INTEGRAL_HANDLE

See Also:

Constant Field Values

T_AVG_LEN_HANDLE

public static final java.lang.String T_AVG_LEN_HANDLE

See Also:

Constant Field Values

I_TBT_HANDLE

public static final java.lang.String I_TBT_HANDLE

See Also:

Constant Field Values

T_DELAY_HANDLE

public static final java.lang.String T_DELAY_HANDLE

See Also:

Constant Field Values

I_AVG_HANDLE

public static final java.lang.String I_AVG_HANDLE

See Also:

Constant Field Values

I_MAX_HANDLE

public static final java.lang.String I_MAX_HANDLE

See Also:

Constant Field Values

Constructor Detail

CurrentMonitor

public CurrentMonitor(java.lang.String strId)

Method Detail

getType

public java.lang.String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getQIntegral

public double getQIntegral()
                    throws ConnectionException,
                           GetException

Integrated current over macropulse

Throws:

ConnectionException

GetException

getTAvgLen

public double getTAvgLen()
                  throws ConnectionException,
                         GetException

Averaged pulse length

Throws:

ConnectionException

GetException

getITBT

public double[] getITBT()
                 throws ConnectionException,
                        GetException

Turn by turn current

Throws:

ConnectionException

GetException

getITBTWithBeamOnly

public double[] getITBTWithBeamOnly()
                             throws ConnectionException,
                                    GetException

Get the portion of ITBT array with beam on only. This method is useful for rf cavity beam loading calculation

Returns:

part of the beam current array with non-zero beam only

Throws:

ConnectionException

GetException

getTDelay

public double getTDelay()
                 throws ConnectionException,
                        GetException

Time delay

Throws:

ConnectionException

GetException

getIAvg

public double getIAvg()
               throws ConnectionException,
                      GetException

Avgerage beam current

Throws:

ConnectionException

GetException

getIMax

public double getIMax()
               throws ConnectionException,
                      GetException

Maximum beam current

Throws:

ConnectionException

GetException