Package xal.smf.impl

Class CurrentMonitor

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.CurrentMonitor

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class CurrentMonitor
extends AcceleratorNode

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

Author:

J. Galambos (jdg@ornl.gov)

Field Summary

Fields

Modifier and Type	Field	Description
final AccessibleProperty	currentAvg
final AccessibleProperty	currentMax
final AccessibleProperty	currentTBT
final AccessibleProperty	displayLength
static final String	I_AVG_HANDLE
static final String	I_MAX_HANDLE
static final String	I_TBT_HANDLE
final AccessibleProperty	particles
static final String	Q_INTEGRAL_HANDLE
static final String	T_AVG_LEN_HANDLE
static final String	T_DELAY_HANDLE
final AccessibleProperty	tDelay
static final String	TYPE	standard type for instances of this class

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
CurrentMonitor(String strId)	Constructor
CurrentMonitor(String strId, ChannelFactory channeFactory)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
double	getIAvg()	Average 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
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

standard type for instances of this class

See Also:

• Constant Field Values

Q_INTEGRAL_HANDLE

public static final String Q_INTEGRAL_HANDLE

See Also:

• Constant Field Values

particles

public final AccessibleProperty particles

T_AVG_LEN_HANDLE

public static final String T_AVG_LEN_HANDLE

See Also:

• Constant Field Values

displayLength

public final AccessibleProperty displayLength

I_TBT_HANDLE

public static final String I_TBT_HANDLE

See Also:

• Constant Field Values

currentTBT

public final AccessibleProperty currentTBT

T_DELAY_HANDLE

public static final String T_DELAY_HANDLE

See Also:

• Constant Field Values

tDelay

public final AccessibleProperty tDelay

I_AVG_HANDLE

public static final String I_AVG_HANDLE

See Also:

• Constant Field Values

currentAvg

public final AccessibleProperty currentAvg

I_MAX_HANDLE

public static final String I_MAX_HANDLE

See Also:

• Constant Field Values

currentMax

public final AccessibleProperty currentMax

Constructor Details

CurrentMonitor

public CurrentMonitor(String strId,
 ChannelFactory channeFactory)

Primary Constructor

CurrentMonitor

public CurrentMonitor(String strId)

Constructor

Method Details

getType

public String getType()

Override to provide type signature

Specified by:

getType in class AcceleratorNode

getQIntegral

public double getQIntegral()
                    throws GetException

Integrated current over macropulse

Throws:

GetException

getTAvgLen

public double getTAvgLen()
                  throws GetException

Averaged pulse length

Throws:

GetException

getITBT

public double[] getITBT()
                 throws GetException

Turn by turn current

Throws:

GetException

getITBTWithBeamOnly

public double[] getITBTWithBeamOnly()
                             throws 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 GetException

Time delay

Throws:

GetException

getIAvg

public double getIAvg()
               throws GetException

Average beam current

Throws:

GetException

getIMax

public double getIMax()
               throws GetException

Maximum beam current

Throws:

GetException