Package gda.device.attenuator

Class EpicsAttenuatorBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.attenuator.EpicsAttenuatorBase

All Implemented Interfaces:

Attenuator, InitializationListener, Configurable, Findable, gov.aps.jca.event.MonitorListener, EventListener

Direct Known Subclasses:

BinaryFilterSetAttenuators

public abstract class EpicsAttenuatorBase
extends FindableConfigurableBase
implements Attenuator, gov.aps.jca.event.MonitorListener, InitializationListener

Field Summary

Fields

Modifier and Type	Field	Description
protected gov.aps.jca.Channel	actualEnergy
protected gov.aps.jca.Channel	actualTransmission
protected gov.aps.jca.Channel	change
protected EpicsChannelManager	channelManager
protected EpicsController	controller
protected gov.aps.jca.Channel	desiredEnergy
protected gov.aps.jca.Channel	desiredTransmission
protected gov.aps.jca.Channel	useCurrentEnergy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EpicsAttenuatorBase()
protected	EpicsAttenuatorBase(EpicsController controller)

Method Summary

Modifier and Type	Method	Description
double	getClosestMatchEnergy()
double	getClosestMatchTransmission(double transmission)	Using the current beam energy, calculates the closest achievable transmission value to the given value with the set of filters
ClosestMatchTransmission	getClosestMatchTransmission(double transmission, double energyInKev)	Uses the given energy in the calculation
double	getDesiredEnergy()
double	getDesiredTransmission()	Returns the stored desired transmission value.
double	getTransmission()	The current transmission, assuming the energy has not changed since the last filter adjustment.
void	initializationCompleted()	Called when all critical channels are connected.
boolean	isReady()	Determines if correct filters are in place (as attenuator makes a change of transmission): Compares the results of Attenuator.getFilterPositions() with Attenuator.getDesiredFilterPositions().
void	monitorChanged(gov.aps.jca.event.MonitorEvent arg0)
double	setTransmission(double transmission)	Changes the attenuation level to the closest achievable transmission to the given value.

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.device.Attenuator

getDesiredFilterPositions, getFilterNames, getFilterPositions, getNumberFilters

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.factory.Findable

getName, setName

Field Details

controller

protected EpicsController controller

channelManager

protected EpicsChannelManager channelManager

desiredEnergy

protected gov.aps.jca.Channel desiredEnergy

desiredTransmission

protected gov.aps.jca.Channel desiredTransmission

actualTransmission

protected gov.aps.jca.Channel actualTransmission

change

protected gov.aps.jca.Channel change

actualEnergy

protected gov.aps.jca.Channel actualEnergy

useCurrentEnergy

protected gov.aps.jca.Channel useCurrentEnergy

Constructor Details

EpicsAttenuatorBase

protected EpicsAttenuatorBase(EpicsController controller)

EpicsAttenuatorBase

protected EpicsAttenuatorBase()

Method Details

getClosestMatchTransmission

public double getClosestMatchTransmission(double transmission)
                                   throws DeviceException

Description copied from interface: Attenuator

Using the current beam energy, calculates the closest achievable transmission value to the given value with the set of filters

Specified by:

getClosestMatchTransmission in interface Attenuator

Parameters:

transmission -

Returns:

double the closest transmission value that could be achieved

Throws:

DeviceException

getClosestMatchTransmission

public ClosestMatchTransmission getClosestMatchTransmission(double transmission,
 double energyInKev)
                                                     throws DeviceException

Description copied from interface: Attenuator

Uses the given energy in the calculation

Specified by:

getClosestMatchTransmission in interface Attenuator

Parameters:

transmission - transmission (0 to 1)

energyInKev - x-ray energy in the stated units

Throws:

DeviceException

setTransmission

public double setTransmission(double transmission)
                       throws DeviceException

Description copied from interface: Attenuator

Changes the attenuation level to the closest achievable transmission to the given value. This uses the current beam energy in its calculations.

Specified by:

setTransmission in interface Attenuator

Parameters:

transmission - the desired transmission

Returns:

the actual transmission value achieved

Throws:

DeviceException

getTransmission

public double getTransmission()
                       throws DeviceException

Description copied from interface: Attenuator

The current transmission, assuming the energy has not changed since the last filter adjustment.

Specified by:

getTransmission in interface Attenuator

Returns:

the current actual transmission

Throws:

DeviceException

monitorChanged

public void monitorChanged(gov.aps.jca.event.MonitorEvent arg0)

Specified by:

monitorChanged in interface gov.aps.jca.event.MonitorListener

initializationCompleted

public void initializationCompleted()

Description copied from interface: InitializationListener

Called when all critical channels are connected.

Specified by:

initializationCompleted in interface InitializationListener

getClosestMatchEnergy

public double getClosestMatchEnergy()
                             throws DeviceException

Specified by:

getClosestMatchEnergy in interface Attenuator

Returns:

double - the actual energy used in calculations to determine the filter set to achieve the desired transmission

Throws:

DeviceException

getDesiredEnergy

public double getDesiredEnergy()
                        throws DeviceException

Specified by:

getDesiredEnergy in interface Attenuator

Returns:

double - the desired energy to use in calculations to determine the filter set to achieve the desired transmission

Throws:

DeviceException

getDesiredTransmission

public double getDesiredTransmission()
                              throws DeviceException

Description copied from interface: Attenuator

Returns the stored desired transmission value.

Specified by:

getDesiredTransmission in interface Attenuator

Returns:

the stored desired transmission value

Throws:

DeviceException

isReady

public boolean isReady()
                throws DeviceException

Description copied from interface: Attenuator

Determines if correct filters are in place (as attenuator makes a change of transmission): Compares the results of Attenuator.getFilterPositions() with Attenuator.getDesiredFilterPositions().

Specified by:

isReady in interface Attenuator

Throws:

DeviceException