Package gda.device.attenuator

Class BinaryFilterSetAttenuators

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.attenuator.EpicsAttenuatorBase

gda.device.attenuator.BinaryFilterSetAttenuators

All Implemented Interfaces:

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

@ServiceInterface(Attenuator.class)
public final class BinaryFilterSetAttenuators
extends EpicsAttenuatorBase

Attenuators as used in certain mx beamlines, I04-1 and phase 1

Field Summary

Fields

Modifier and Type	Field	Description
protected gov.aps.jca.Channel[]	calculatedChannels
protected gov.aps.jca.Channel[]	filterChannels

Fields inherited from class gda.device.attenuator.EpicsAttenuatorBase

actualEnergy, actualTransmission, change, channelManager, controller, desiredEnergy, desiredTransmission, useCurrentEnergy

Constructor Summary

Constructors

Constructor	Description
BinaryFilterSetAttenuators(AttenuatingFilterNames configuredFilterNames)

Method Summary

Modifier and Type	Method	Description
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
boolean[]	getDesiredFilterPositions()	Returns array (indexing over filter elements) answering the question: "Is this filter required to be in the beam (to achieve the closest match transmission)?", as per the requested transmission most recently supplied to the Attenuator.getClosestMatchTransmission(double) method.
String[]	getFilterNames()	Names available filters
boolean[]	getFilterPositions()	Returns array (indexing over filter elements) answering the question: "Is filter (presently) in the beam?".
int	getNumberFilters()	Counts the filters available
void	setPvPrefix(String pvPrefix)

Methods inherited from class gda.device.attenuator.EpicsAttenuatorBase

getClosestMatchEnergy, getClosestMatchTransmission, getClosestMatchTransmission, getDesiredEnergy, getDesiredTransmission, getTransmission, initializationCompleted, isReady, monitorChanged, setTransmission

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.factory.Findable

getName, setName

Field Details

filterChannels

protected gov.aps.jca.Channel[] filterChannels

calculatedChannels

protected gov.aps.jca.Channel[] calculatedChannels

Constructor Details

BinaryFilterSetAttenuators

public BinaryFilterSetAttenuators(AttenuatingFilterNames configuredFilterNames)

Method Details

setPvPrefix

public void setPvPrefix(String pvPrefix)

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

getFilterPositions

public boolean[] getFilterPositions()
                             throws DeviceException

Description copied from interface: Attenuator

Returns array (indexing over filter elements) answering the question:
"Is filter (presently) in the beam?".

Throws:

DeviceException

getDesiredFilterPositions

public boolean[] getDesiredFilterPositions()
                                    throws DeviceException

Description copied from interface: Attenuator

Returns array (indexing over filter elements) answering the question:
"Is this filter required to be in the beam (to achieve the closest match transmission)?",

as per the requested transmission most recently supplied to the Attenuator.getClosestMatchTransmission(double) method.

Throws:

DeviceException

getNumberFilters

public int getNumberFilters()
                     throws DeviceException

Description copied from interface: Attenuator

Counts the filters available

Returns:

the number of filters in this attenuator

Throws:

DeviceException

getFilterNames

public String[] getFilterNames()
                        throws DeviceException

Description copied from interface: Attenuator

Names available filters

Returns:

the names of the filters in this attenuator

Throws:

DeviceException