Package gda.device.epicsdevice

Class FindableEpicsDevice

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.epicsdevice.FindableEpicsDevice

All Implemented Interfaces:

Device, IEpicsDevice, IFindableEpicsDevice, Configurable, Findable, gda.observable.IObservable

public class FindableEpicsDevice
extends DeviceBase
implements IFindableEpicsDevice

A generic Epics device object which can be used for low-level access to arbitrary devices, most commonly XMAP devices.

It manages a map of "field names" to PVs, for example:

 <entry key="SETNBINS" value="BL08I-EA-DET-02:MCA1.NUSE" /> 
 

and Epics channel access (via an EpicsDevice) and translates calls such as:

 setValue("SETNBINS", "" numberOfBins) 
 

to the appropriate channel access call, using the PV mapping.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	dummy

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.epicsdevice.IEpicsDevice

defPutTimeOutInSec

Constructor Summary

Constructors

Constructor	Description
FindableEpicsDevice()
FindableEpicsDevice(String name, EpicsDevice epicsDevice)

Method Summary

Modifier and Type	Method	Description
Object	__getattr__(org.python.core.PyString name)
void	addIObserver(gda.observable.IObserver anIObserver)
void	close()	Close and unconfigure the device.
void	closeUnUsedChannels()
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.
static IEpicsChannel	createChannel(ReturnType returnType, String device, String record, String field)
Detector	createDetector(String record, String field)
Detector	createDetector(String name, String record, String field)
IEpicsChannel	createEpicsChannel()
IEpicsChannel	createEpicsChannel(ReturnType returnType, String record, String field)
IEpicsChannel	createEpicsChannel(ReturnType returnType, String record, String field, double putTimeout)
IEpicsChannel	createEpicsChannel(String name)
IEpicsChannel	createEpicsChannel(String name, ReturnType returnType, String record, String field)
static IEpicsChannel	createSimpleScannable(String device, String record, String field)
void	deleteIObserver(gda.observable.IObserver anIObserver)
void	deleteIObservers()
void	dispose()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
static IEpicsChannel	getCtrlEnumChannel(String device, String record, String field)
boolean	getDummy()
int	getElementCount(String record, String field)
String	getRecordPV(String mcaName)	Get the PV associated with a given element
Map<String,String>	getRecordPVs()
Object	getValue()
Object	getValue(ReturnType returnType, String record, String field)	Get the value of an Epics record, specifying the return type required
String	getValueAsString(String record, String field)	Get the value of an Epics record as a string
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setDummy(boolean dummy)
void	setRecordPVs(Map<String,String> recordPVs)
void	setValue(Object val)
void	setValue(Object type, String record, String field, Object val, double putTimeout)	Set the value of an Epics record, specifying the type
void	setValue(String record, String field, Object val)	Set the value of an Epics record, using a default timeout.
void	setValue(String record, String field, Object val, double connectionTimeout, gov.aps.jca.event.PutListener listener)
void	setValueNoWait(String record, String field, Object val)	Set the value of an Epics record, without waiting for the put to complete
String	toString()

Methods inherited from class gda.device.DeviceBase

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, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Field Details

dummy

protected boolean dummy

Constructor Details

FindableEpicsDevice

public FindableEpicsDevice()

FindableEpicsDevice

public FindableEpicsDevice(String name,
 EpicsDevice epicsDevice)

Method Details

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

getRecordPVs

public Map<String,String> getRecordPVs()

setRecordPVs

public void setRecordPVs(Map<String,String> recordPVs)

getRecordPV

public String getRecordPV(String mcaName)

Description copied from interface: IFindableEpicsDevice

Get the PV associated with a given element

Specified by:

getRecordPV in interface IFindableEpicsDevice

Parameters:

mcaName - Name of the element

Returns:

Corresponding PV

setDummy

public void setDummy(boolean dummy)

getDummy

public boolean getDummy()

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

getAttribute

public Object getAttribute(String attributeName)
                    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:

attributeName - 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 attributeName,
 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:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

addIObserver

public void addIObserver(gda.observable.IObserver anIObserver)

Specified by:

addIObserver in interface gda.observable.IObservable

Overrides:

addIObserver in class DeviceBase

deleteIObserver

public void deleteIObserver(gda.observable.IObserver anIObserver)

Specified by:

deleteIObserver in interface gda.observable.IObservable

Overrides:

deleteIObserver in class DeviceBase

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

Overrides:

deleteIObservers in class DeviceBase

createEpicsChannel

public IEpicsChannel createEpicsChannel(ReturnType returnType,
 String record,
 String field,
 double putTimeout)

Specified by:

createEpicsChannel in interface IEpicsDevice

Parameters:

returnType -

record -

field -

putTimeout -

Returns:

IEpicsChannel

createEpicsChannel

public IEpicsChannel createEpicsChannel(ReturnType returnType,
 String record,
 String field)

Specified by:

createEpicsChannel in interface IEpicsDevice

Parameters:

returnType -

record -

field -

Returns:

IEpicsChannel

createEpicsChannel

public IEpicsChannel createEpicsChannel()

createEpicsChannel

public IEpicsChannel createEpicsChannel(String name,
 ReturnType returnType,
 String record,
 String field)

createEpicsChannel

public IEpicsChannel createEpicsChannel(String name)

createDetector

public Detector createDetector(String record,
 String field)

createDetector

public Detector createDetector(String name,
 String record,
 String field)

getValue

public Object getValue(ReturnType returnType,
 String record,
 String field)
                throws DeviceException

Description copied from interface: IFindableEpicsDevice

Get the value of an Epics record, specifying the return type required

Specified by:

getValue in interface IFindableEpicsDevice

Parameters:

returnType - One of the permitted values of ReturnType

record - Epics record to get

field - Field within the record (can be empty string)

Returns:

Value of the Epics record

Throws:

DeviceException

getValueAsString

public String getValueAsString(String record,
 String field)
                        throws DeviceException

Description copied from interface: IFindableEpicsDevice

Get the value of an Epics record as a string

Specified by:

getValueAsString in interface IFindableEpicsDevice

Parameters:

record - Epics record to get

field - Field within the record (can be empty string)

Returns:

Value of the Epics record as a string

Throws:

DeviceException

getElementCount

public int getElementCount(String record,
 String field)
                    throws DeviceException

Throws:

DeviceException

getValue

public Object getValue()
                throws DeviceException

Throws:

DeviceException

setValue

public void setValue(Object type,
 String record,
 String field,
 Object val,
 double putTimeout)
              throws DeviceException

Description copied from interface: IFindableEpicsDevice

Set the value of an Epics record, specifying the type

Specified by:

setValue in interface IFindableEpicsDevice

Parameters:

type - Type of the value: note that null may be the only valid value in some implementations

record - Epics record to set

field - Field within the record (can be empty string)

val - Value to set

putTimeout - Timeout on the call in seconds

Throws:

DeviceException

setValue

public void setValue(String record,
 String field,
 Object val,
 double connectionTimeout,
 gov.aps.jca.event.PutListener listener)
              throws DeviceException

Throws:

DeviceException

setValue

public void setValue(String record,
 String field,
 Object val)
              throws DeviceException

Description copied from interface: IFindableEpicsDevice

Set the value of an Epics record, using a default timeout.

Specified by:

setValue in interface IFindableEpicsDevice

Parameters:

record - Epics record to set

field - Field within the record (can be empty string)

val - Value to set

Throws:

DeviceException

setValueNoWait

public void setValueNoWait(String record,
 String field,
 Object val)
                    throws DeviceException

Description copied from interface: IFindableEpicsDevice

Set the value of an Epics record, without waiting for the put to complete

Specified by:

setValueNoWait in interface IFindableEpicsDevice

Parameters:

record - Epics record to set

field - Field within the record (can be empty string)

val - Value to set

Throws:

DeviceException

setValue

public void setValue(Object val)
              throws DeviceException

Throws:

DeviceException

dispose

public void dispose()
             throws DeviceException

Specified by:

dispose in interface IEpicsDevice

Throws:

DeviceException

closeUnUsedChannels

public void closeUnUsedChannels()
                         throws DeviceException

Specified by:

closeUnUsedChannels in interface IEpicsDevice

Throws:

DeviceException

createSimpleScannable

public static IEpicsChannel createSimpleScannable(String device,
 String record,
 String field)

createChannel

public static IEpicsChannel createChannel(ReturnType returnType,
 String device,
 String record,
 String field)

getCtrlEnumChannel

public static IEpicsChannel getCtrlEnumChannel(String device,
 String record,
 String field)
                                        throws DeviceException

Throws:

DeviceException

toString

public String toString()

Overrides:

toString in class Object

__getattr__

public Object __getattr__(org.python.core.PyString name)