xal.smf.impl

Class MagnetMainSupply

java.lang.Object

xal.smf.impl.MagnetPowerSupply

xal.smf.impl.MagnetMainSupply

All Implemented Interfaces:

DataListener

public class MagnetMainSupply
extends MagnetPowerSupply

MainMagnetSupply represents a power supply that is the main supply for a magnet.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CYCLE_ENABLE_HANDLE
static java.lang.String	FIELD_BOOK_HANDLE
static java.lang.String	FIELD_RB_HANDLE
static java.lang.String	FIELD_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
MagnetMainSupply(Accelerator anAccelerator) Creates a new instance of MainSupply

Method Summary

Modifier and Type	Method and Description
double	getField() Get the field contribution from this power supply.
double	getFieldSetting() Get the value to which the field is set.
java.lang.String	getType() Get the power supply type
double	lowerAlarmFieldLimit() Get the field lower alarm limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerDisplayFieldLimit() get the field lower display limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerFieldLimit() get the field lower settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	lowerWarningFieldLimit() Get the field lower warning limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
protected void	setCycleEnable(boolean enable) Set the cycle enable state of the magnet power supply.
void	setField(double newField) Set the field contribution from this power supply.
boolean	suppliesNode(AcceleratorNode node) Check if the electromagnet is supplied by this power supply.
double	upperAlarmFieldLimit() Get the field upper alarm limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperDisplayFieldLimit() get the field upper display limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperFieldLimit() get the field upper settable limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc.
double	upperWarningFieldLimit() Get the field upper warning 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

CYCLE_ENABLE_HANDLE

public static final java.lang.String CYCLE_ENABLE_HANDLE

See Also:

Constant Field Values

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

FIELD_BOOK_HANDLE

public static final java.lang.String FIELD_BOOK_HANDLE

See Also:

Constant Field Values

Constructor Detail

MagnetMainSupply

public MagnetMainSupply(Accelerator anAccelerator)

Creates a new instance of MainSupply

Method Detail

getType

public java.lang.String getType()

Get the power supply type

Specified by:

getType in class MagnetPowerSupply

Returns:

The power supply type

setCycleEnable

protected void setCycleEnable(boolean enable)
                       throws ConnectionException,
                              PutException

Set the cycle enable state of the magnet power supply. If enabled, the magnet will be cycled when the field is set.

Parameters:

enable - True to enable cycling; false to disable cycling.

Throws:

ConnectionException

PutException

getField

public double getField()
                throws ConnectionException,
                       GetException

Get the 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 field contribution from this power supply. If cycle enable is set to true the field is cycled otherwise it is simply set to the specified value.

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

upperDisplayFieldLimit

public double upperDisplayFieldLimit()
                              throws ConnectionException,
                                     GetException

get the field upper display limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc. This is the preferred upper field limit for setting magnets as it represents an operational limit.

Throws:

ConnectionException

GetException

lowerDisplayFieldLimit

public double lowerDisplayFieldLimit()
                              throws ConnectionException,
                                     GetException

get the field lower display limit in T/(m^(n-1)), where n = 1 for dipole, 2 for quad, etc. This is the preferred lower field limit for setting magnets as it represents an operational limit.

Throws:

ConnectionException

GetException

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

upperAlarmFieldLimit

public double upperAlarmFieldLimit()
                            throws ConnectionException,
                                   GetException

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

Throws:

ConnectionException

GetException

lowerAlarmFieldLimit

public double lowerAlarmFieldLimit()
                            throws ConnectionException,
                                   GetException

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

Throws:

ConnectionException

GetException

upperWarningFieldLimit

public double upperWarningFieldLimit()
                              throws ConnectionException,
                                     GetException

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

Throws:

ConnectionException

GetException

lowerWarningFieldLimit

public double lowerWarningFieldLimit()
                              throws ConnectionException,
                                     GetException

Get the field lower warning 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