Package gda.device.adc

Class EpicsADC

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.adc.EpicsADC

All Implemented Interfaces:

Adc, Device, InitializationListener, Configurable, Findable, gda.observable.IObservable

public class EpicsADC
extends DeviceBase
implements Adc, InitializationListener

EpicsADC Class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EpicsADC.amodEnum	amod enum
static enum	EpicsADC.cmodEnum	cmod enum
static enum	EpicsADC.gmodEnum	gmod enum
static enum	EpicsADC.pmodEnum	pmod enum
static enum	EpicsADC.tmodEnum	tmod enum

Field Summary

Fields

Modifier and Type	Field	Description
static String	AMOD
static String	CMOD
double[]	Gain	Gains
static String	GAIN
static String	GAIN_VALUES
static String	GMOD
static String	LLD
static String	OFFSET
static String	PMOD
static String	TMOD
static String	ULD
static String	ZERO

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
EpicsADC()	Constructor.

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.
Object	getAttribute(String attribute)	Get the value of the specified attribute
double	getGain()
double	getLld()
double	getOffset()
int	getRange(int channel)	Get the current voltage Range for the specified channel.
int[]	getRanges()	Get the supported ranges for a particular ADC.
String	getScanMode()
int	getScanModeInteger()
double	getVoltage(int channel)	Get the current voltage for the specified channel.
double[]	getVoltages()	Get the current voltage from all open channels.
void	initializationCompleted()	Called when all critical channels are connected.
boolean	isUniPolarSettable()	Get the polarity capability of the ADC.
void	setAdcRecordName(String adcRecordName)
void	setAmod(EpicsADC.amodEnum amod)
void	setAttribute(String attribute, Object value)	Set any attribute the implementing classes may provide
void	setCmod(EpicsADC.cmodEnum cmod)
void	setGain(double gain)
void	setGmod(EpicsADC.gmodEnum gmod)
void	setLld(double lld)
void	setOffset(double offset)
void	setPmod(EpicsADC.pmodEnum pmod)
void	setRange(int channel, int range)	Set the voltage Range for the specified channel.
void	setSampleCount(int count)	Set the sample count for the ADC monitoring.
void	setScanMode(int mode)
void	setScanMode(String mode)
void	setTmod(EpicsADC.tmodEnum tmod)
void	setUld(double uld)
void	setUniPolar(int channel, boolean polarity)	Set the unipolar or bipolar mode for a specified channel.
void	setZero(double zero)

Methods inherited from class gda.device.DeviceBase

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

Methods inherited from class gda.factory.ConfigurableBase

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.device.Device

close, getProtectionLevel, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Field Details

Gain

public double[] Gain

Gains

GAIN

public static String GAIN

OFFSET

public static String OFFSET

LLD

public static String LLD

ULD

public static String ULD

ZERO

public static String ZERO

AMOD

public static String AMOD

CMOD

public static String CMOD

PMOD

public static String PMOD

GMOD

public static String GMOD

TMOD

public static String TMOD

GAIN_VALUES

public static String GAIN_VALUES

Constructor Details

EpicsADC

public EpicsADC()

Constructor.

Method Details

setAdcRecordName

public void setAdcRecordName(String adcRecordName)

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

getVoltage

public double getVoltage(int channel)
                  throws DeviceException

Description copied from interface: Adc

Get the current voltage for the specified channel.

Specified by:

getVoltage in interface Adc

Parameters:

channel - the ADC channel to read

Returns:

the current voltage (units are implementation specific)

Throws:

DeviceException

getVoltages

public double[] getVoltages()
                     throws DeviceException

Description copied from interface: Adc

Get the current voltage from all open channels.

Specified by:

getVoltages in interface Adc

Returns:

the current voltages (units are implementation specific)

Throws:

DeviceException

setRange

public void setRange(int channel,
 int range)
              throws DeviceException

Description copied from interface: Adc

Set the voltage Range for the specified channel.

Specified by:

setRange in interface Adc

Parameters:

channel - the ADC channel to set

range - the range to set (units are implementation specific)

Throws:

DeviceException

See Also:

• Adc.getRange(int)

getRange

public int getRange(int channel)
             throws DeviceException

Description copied from interface: Adc

Get the current voltage Range for the specified channel.

Specified by:

getRange in interface Adc

Parameters:

channel - the ADC channel to get

Returns:

the range (units are implementation specific)

Throws:

DeviceException

See Also:

• Adc.setRange(int, int)

setUniPolar

public void setUniPolar(int channel,
 boolean polarity)
                 throws DeviceException

Description copied from interface: Adc

Set the unipolar or bipolar mode for a specified channel.

Specified by:

setUniPolar in interface Adc

Parameters:

channel - the ADC channel to set

polarity - unipolar mode either true or false

Throws:

DeviceException

See Also:

• Adc.isUniPolarSettable()

getRanges

public int[] getRanges()
                throws DeviceException

Description copied from interface: Adc

Get the supported ranges for a particular ADC.

Specified by:

getRanges in interface Adc

Returns:

the supported voltage ranges (units are implementation specific)

Throws:

DeviceException

isUniPolarSettable

public boolean isUniPolarSettable()
                           throws DeviceException

Description copied from interface: Adc

Get the polarity capability of the ADC.

Specified by:

isUniPolarSettable in interface Adc

Returns:

true if UNIPOLAR is supported else assume BIPOLAR

Throws:

DeviceException

setSampleCount

public void setSampleCount(int count)
                    throws DeviceException

Description copied from interface: Adc

Set the sample count for the ADC monitoring.

Specified by:

setSampleCount in interface Adc

Parameters:

count - the number of samples to read

Throws:

DeviceException

getGain

public double getGain()
               throws gov.aps.jca.CAException,
gov.aps.jca.TimeoutException,
InterruptedException

Returns:

Gain

Throws:

gov.aps.jca.CAException

gov.aps.jca.TimeoutException

InterruptedException

setGain

public void setGain(double gain)
             throws gov.aps.jca.CAException,
InterruptedException

Parameters:

gain -

Throws:

gov.aps.jca.CAException

InterruptedException

getLld

public double getLld()
              throws gov.aps.jca.CAException,
gov.aps.jca.TimeoutException,
InterruptedException

Returns:

Low Level Discriminator

Throws:

gov.aps.jca.CAException

gov.aps.jca.TimeoutException

InterruptedException

setLld

public void setLld(double lld)
            throws gov.aps.jca.CAException,
InterruptedException

Parameters:

lld - Low Level Discriminator

Throws:

gov.aps.jca.CAException

InterruptedException

getOffset

public double getOffset()
                 throws gov.aps.jca.CAException,
gov.aps.jca.TimeoutException,
InterruptedException

Returns:

Offset

Throws:

gov.aps.jca.CAException

gov.aps.jca.TimeoutException

InterruptedException

setOffset

public void setOffset(double offset)
               throws gov.aps.jca.CAException,
InterruptedException

Parameters:

offset -

Throws:

gov.aps.jca.CAException

InterruptedException

getAttribute

public Object getAttribute(String attribute)
                    throws DeviceException

Description copied from interface: Device

Get the value of the specified attribute

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class DeviceBase

Parameters:

attribute - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException - if an attribute cannot be retrieved

setAttribute

public void setAttribute(String attribute,
 Object value)
                  throws DeviceException

Description copied from interface: Device

Set any attribute the implementing classes may provide

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

attribute - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

setTmod

public void setTmod(EpicsADC.tmodEnum tmod)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setGmod

public void setGmod(EpicsADC.gmodEnum gmod)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setPmod

public void setPmod(EpicsADC.pmodEnum pmod)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setCmod

public void setCmod(EpicsADC.cmodEnum cmod)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setAmod

public void setAmod(EpicsADC.amodEnum amod)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setZero

public void setZero(double zero)
             throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

setUld

public void setUld(double uld)
            throws gov.aps.jca.CAException,
InterruptedException

Throws:

gov.aps.jca.CAException

InterruptedException

initializationCompleted

public void initializationCompleted()

Description copied from interface: InitializationListener

Called when all critical channels are connected.

Specified by:

initializationCompleted in interface InitializationListener

setScanMode

public void setScanMode(int mode)
                 throws DeviceException

Parameters:

mode -

Throws:

DeviceException

setScanMode

public void setScanMode(String mode)
                 throws DeviceException

Parameters:

mode -

Throws:

DeviceException

getScanMode

public String getScanMode()
                   throws DeviceException

Returns:

The ScanMode as a String

Throws:

DeviceException

getScanModeInteger

public int getScanModeInteger()
                       throws DeviceException

Returns:

The ScanMode as an Integer

Throws:

DeviceException