Package gda.device.filterarray

Class DummyFilterArray

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.filterarray.FilterArrayBase

gda.device.filterarray.DummyFilterArray

All Implemented Interfaces:

Device, FilterArray, Configurable, Findable, gda.observable.IObservable

public class DummyFilterArray
extends FilterArrayBase

Simulated implementation of the FilterArray interface.

Field Summary

Fields inherited from class gda.device.filterarray.FilterArrayBase

useMonoEnergy

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DummyFilterArray()

Method Summary

Modifier and Type	Method	Description
double	getAbsorption()	Returns the current absorption level.
double	getCalculationEnergy()	Returns the energy value currently being used to calculate the absorption and transmission.
double	getCalculationWavelength()	Returns the wavelength value currently being used to calculate the absorption and transmission.
double	getTransmission()	Returns the current transmission level.
void	setAbsorption(double absorption)	Tells the filter array to move so that, for the current energy used in its calculations, the absorption is as close as possible to the value supplied
void	setCalculationEnergy(double energy)	Sets the energy value which would be used to calculate the absorption and transmission if isUsingMonoEnergy return false.
void	setCalculationWavelength(double wavelength)	Sets the wavelength value which would be used to calculate the absorption and transmission if isUsingMonoEnergy return false.
void	setTransmission(double transmission)	Tells the filter array to move so that, for the current energy used in its calculations, the transmission is as close as possible to the value supplied.

Methods inherited from class gda.device.filterarray.FilterArrayBase

isUsingMonoEnergy, setUseMonoEnergy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, 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.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Constructor Details

DummyFilterArray

public DummyFilterArray()

Method Details

getAbsorption

public double getAbsorption()
                     throws DeviceException

Description copied from interface: FilterArray

Returns the current absorption level. This value is calculated from the filters currently in place and the energy this device is set to work with. The value is not necessarily the value given to the object via the setAbsorption method.

Returns:

a double between 0 and 1

Throws:

DeviceException

setAbsorption

public void setAbsorption(double absorption)
                   throws DeviceException

Description copied from interface: FilterArray

Tells the filter array to move so that, for the current energy used in its calculations, the absorption is as close as possible to the value supplied

Parameters:

absorption - - a double between 0 and 1

Throws:

DeviceException

getTransmission

public double getTransmission()
                       throws DeviceException

Description copied from interface: FilterArray

Returns the current transmission level. This value is calculated from the filters currently in place and the energy this device is set to work with. The value is not necessarily the value given to the object via the setTransmission method.

Returns:

the current transmission level

Throws:

DeviceException

setTransmission

public void setTransmission(double transmission)
                     throws DeviceException

Description copied from interface: FilterArray

Tells the filter array to move so that, for the current energy used in its calculations, the transmission is as close as possible to the value supplied.

Parameters:

transmission - the transmission value

Throws:

DeviceException

getCalculationEnergy

public double getCalculationEnergy()
                            throws DeviceException

Description copied from interface: FilterArray

Returns the energy value currently being used to calculate the absorption and transmission.

Returns:

the energy value

Throws:

DeviceException

setCalculationEnergy

public void setCalculationEnergy(double energy)
                          throws DeviceException

Description copied from interface: FilterArray

Sets the energy value which would be used to calculate the absorption and transmission if isUsingMonoEnergy return false.

Parameters:

energy - the energy value which would be used to calculate the absorption and transmission

Throws:

DeviceException

getCalculationWavelength

public double getCalculationWavelength()
                                throws DeviceException

Description copied from interface: FilterArray

Returns the wavelength value currently being used to calculate the absorption and transmission.

Returns:

the wavelength

Throws:

DeviceException

setCalculationWavelength

public void setCalculationWavelength(double wavelength)
                              throws DeviceException

Description copied from interface: FilterArray

Sets the wavelength value which would be used to calculate the absorption and transmission if isUsingMonoEnergy return false.

Parameters:

wavelength - the wavelength value which would be used to calculate the absorption and transmission

Throws:

DeviceException