Package gda.device.epicsdevice

Class EpicsDevice

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.epicsdevice.EpicsDevice

All Implemented Interfaces:

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

public class EpicsDevice
extends DeviceBase
implements IEpicsDevice, gda.observable.IObserver

Control devices using the Epics Valve/Shutter template.

This class operates two Epics records: a record which controls the device and a record which holds the status. The positions are: "Open", "Close" and "Reset". There are 5 values for the status: "Open", "Opening", "Closed", "Closing" and "Fault".

The stop method in this class does nothing as the valves operate too fast for such a method to be meaningful.

Field Summary

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
EpicsDevice(String name, Map<String,String> recordPVs, boolean inDummyMode)	Constructor.
EpicsDevice(Map<String,String> recordPVs, boolean inDummyMode)

Method Summary

Modifier and Type	Method	Description
Object	__getattr__(String name)	The Python interpreter calls this to find an attribute before it looks for a real attribute on an object.
Object	__getattr__(org.python.core.PyString name)	See __findattr__(String name)
void	closeUnUsedChannels()
Detector	createDetector(String record, String field)
Detector	createDetector(String name, String record, String field)
IEpicsChannel	createEpicsChannel(ReturnType returnType, String record, String field)
IEpicsChannel	createEpicsChannel(ReturnType returnType, String record, String field, double putTimeOutInSec)
IEpicsChannel	createEpicsChannel(String name, ReturnType returnType, String record, String field)
IEpicsChannel	createEpicsChannel(String name, ReturnType returnType, String record, String field, double putTimeOutInSec)
void	dispose()
Object	getAttribute(String _attributeName)	Get the value of the specified attribute
String	getDocString()
int	getElementCount(String record, String field)
Object	getValue(ReturnType returnType, String record, String field)
static Double	getValue(String deviceName, String record, String field)
String	getValueAsString(String record, String field)
boolean	isInDummyMode()
void	notifyIObservers(Object theObserved, Object theArgument)	Notify all observers on the list of the requested change.
void	setAttribute(String _attributeName, Object value)	Set any attribute the implementing classes may provide
void	setDocString(String docString)
void	setValue(String record, String field, Object value, double timeout)
void	setValue(String record, String field, Object value, double connection_timeout, gov.aps.jca.event.PutListener listener)
void	update(Object theObserved, Object changeCode)

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, 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, isConfigured, reconfigure

Constructor Details

EpicsDevice

public EpicsDevice(String name,
 Map<String,String> recordPVs,
 boolean inDummyMode)
            throws DeviceException

Constructor.

Parameters:

name -

recordPVs -

inDummyMode -

Throws:

DeviceException

EpicsDevice

public EpicsDevice(Map<String,String> recordPVs,
 boolean inDummyMode)
            throws DeviceException

Parameters:

recordPVs -

inDummyMode -

Throws:

DeviceException

Method Details

getDocString

public String getDocString()

Returns:

docString

setDocString

public void setDocString(String docString)

Parameters:

docString -

dispose

public void dispose()
             throws DeviceException

Specified by:

dispose in interface IEpicsDevice

Throws:

DeviceException

See Also:

• IEpicsDevice.dispose()

setValue

public void setValue(String record,
 String field,
 Object value,
 double timeout)
              throws DeviceException

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

See Also:

• DeviceBase.getAttribute(java.lang.String)

notifyIObservers

public void notifyIObservers(Object theObserved,
 Object theArgument)

Description copied from class: DeviceBase

Notify all observers on the list of the requested change.

This function should ideally be protected, but is left as public for the time being because inner classes of subclasses cannot access protected members if they are in different bundles.

Overrides:

notifyIObservers in class DeviceBase

Parameters:

theObserved - the observed component

theArgument - the data to be sent to the observer.

See Also:

• DeviceBase.notifyIObservers(java.lang.Object, java.lang.Object)

closeUnUsedChannels

public void closeUnUsedChannels()
                         throws DeviceException

Specified by:

closeUnUsedChannels in interface IEpicsDevice

Throws:

DeviceException

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

See Also:

• DeviceBase.setAttribute(java.lang.String, java.lang.Object)

update

public void update(Object theObserved,
 Object changeCode)

Specified by:

update in interface gda.observable.IObserver

See Also:

• IObserver.update(java.lang.Object, java.lang.Object)

getValue

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

Throws:

DeviceException

getValueAsString

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

Parameters:

record -

field -

Returns:

String

Throws:

DeviceException

getElementCount

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

Parameters:

record -

field -

Returns:

Element Count

Throws:

DeviceException

createEpicsChannel

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

Specified by:

createEpicsChannel in interface IEpicsDevice

Parameters:

returnType -

record -

field -

putTimeOutInSec -

Returns:

IEpicsChannel

createEpicsChannel

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

Parameters:

name -

returnType -

record -

field -

putTimeOutInSec -

Returns:

IEpicsChannel

createDetector

public Detector createDetector(String record,
 String field)

Parameters:

record -

field -

Returns:

Detector

createDetector

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

Parameters:

name -

record -

field -

Returns:

Detector

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(String name,
 ReturnType returnType,
 String record,
 String field)

Parameters:

name -

returnType -

record -

field -

Returns:

IEpicsChannel

getValue

public static Double getValue(String deviceName,
 String record,
 String field)
                       throws DeviceException

Parameters:

deviceName -

record -

field -

Returns:

double value

Throws:

DeviceException

__getattr__

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

See __findattr__(String name)

Parameters:

name -

Returns:

the

__getattr__

public Object __getattr__(String name)

The Python interpreter calls this to find an attribute before it looks for a real attribute on an object. Here it returns the an EpicsDevice field (or docstring).

Parameters:

name -

Returns:

EpicsDevice field (or docstring).

isInDummyMode

public boolean isInDummyMode()

Returns:

Returns the inDummyMode.

setValue

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

Throws:

DeviceException