xal.smf.impl

Class MagnetTrimSupply

java.lang.Object

xal.smf.impl.MagnetPowerSupply

xal.smf.impl.MagnetTrimSupply

All Implemented Interfaces:

DataListener

public class MagnetTrimSupply
extends MagnetPowerSupply

TrimMagnetSupply is a power supply that represents a trim magnet supply.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_RB_HANDLE
static java.lang.String	FIELD_SET_HANDLE
static java.lang.String	TRIM_CURRENT_RB_HANDLE
static java.lang.String	TRIM_CURRENT_SET_HANDLE

Fields inherited from class xal.smf.impl.MagnetPowerSupply

accelerator, channelSuite, CURRENT_RB_HANDLE, CURRENT_SET_HANDLE, CYCLE_INVALID, CYCLE_STATE_HANDLE, CYCLE_VALID, CYCLING, strId

Constructor Summary

Constructors

Constructor and Description
MagnetTrimSupply(Accelerator anAccelerator) Creates a new instance of TrimMagnetSupply

Method Summary

Modifier and Type	Method and Description
double	getField() Get the trim field contribution from this power supply.
double	getFieldSetting() Get the value to which the field is set.
double	getTrimCurrent() Get the magnet trim power supply current
java.lang.String	getType() Get the power supply type
double	lowerFieldLimit() get the field lower settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
void	setField(double newField) Set the trim field contribution from this power supply.
void	setTrimCurrent(double current) Set the magnet trim power supply current.
boolean	suppliesNode(AcceleratorNode node) Check if the electromagnet is supplied by this power supply.
double	upperFieldLimit() get the field upper settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Methods inherited from class xal.smf.impl.MagnetPowerSupply

dataLabel, findChannel, getAndConnectChannel, getChannel, getChannelSuite, getCurrent, getCycleState, getId, getNodes, getNodes, lowerCurrentLimit, setCurrent, update, upperCurrentLimit, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_SET_HANDLE

public static final java.lang.String FIELD_SET_HANDLE

See Also:

Constant Field Values

FIELD_RB_HANDLE

public static final java.lang.String FIELD_RB_HANDLE

See Also:

Constant Field Values

TRIM_CURRENT_SET_HANDLE

public static final java.lang.String TRIM_CURRENT_SET_HANDLE

See Also:

Constant Field Values

TRIM_CURRENT_RB_HANDLE

public static final java.lang.String TRIM_CURRENT_RB_HANDLE

See Also:

Constant Field Values

Constructor Detail

MagnetTrimSupply

public MagnetTrimSupply(Accelerator anAccelerator)

Creates a new instance of TrimMagnetSupply

Method Detail

getType

public java.lang.String getType()

Get the power supply type

Specified by:

getType in class MagnetPowerSupply

Returns:

The power supply type

getField

public double getField()
                throws ConnectionException,
                       GetException

Get the trim field contribution from this power supply. T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Returns:

the field contribution

Throws:

ConnectionException

GetException

setField

public void setField(double newField)
              throws ConnectionException,
                     PutException

Set the trim field contribution from this power supply.

Parameters:

newField - is the new field level in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

PutException

getFieldSetting

public double getFieldSetting()
                       throws ConnectionException,
                              GetException

Get the value to which the field is set. Note that this is not the readback.

Returns:

the field setting in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

getTrimCurrent

public double getTrimCurrent()
                      throws ConnectionException,
                             GetException

Get the magnet trim power supply current

Returns:

the magnet trim power supply current in amperes

Throws:

ConnectionException - if the readback channel cannot be connected

GetException - if the readback channel get action fails

setTrimCurrent

public void setTrimCurrent(double current)
                    throws ConnectionException,
                           PutException

Set the magnet trim power supply current.

Parameters:

current - The current in amperes

Throws:

ConnectionException - if the put channel cannot be connected

PutException - if the put channel set action fails

upperFieldLimit

public double upperFieldLimit()
                       throws ConnectionException,
                              GetException

get the field upper settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

lowerFieldLimit

public double lowerFieldLimit()
                       throws ConnectionException,
                              GetException

get the field lower settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.

Throws:

ConnectionException

GetException

suppliesNode

public boolean suppliesNode(AcceleratorNode node)

Check if the electromagnet is supplied by this power supply.

Specified by:

suppliesNode in class MagnetPowerSupply

Parameters:

node - The electromagnet to check

Returns:

true if the node is supplied by this supply and false otherwise