Package org.scictrl.csshell.epics

Class EPICSConnection<T>

java.lang.Object

org.scictrl.csshell.epics.EPICSConnection<T>

Type Parameters:

T - data type

All Implemented Interfaces:

gov.aps.jca.event.ConnectionListener, EventListener, Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

public class EPICSConnection<T>
extends Object
implements Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>, gov.aps.jca.event.ConnectionListener

EPICSConnection class.

Author:

igor@scictrl.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EPICSConnection.GetRequest	Get request object, a callback for get calls.
class	EPICSConnection.PutRequest	Put request object.

Field Summary

Fields inherited from interface org.scictrl.csshell.Connection

PROPERTY_ALARM, PROPERTY_META_DATA, PROPERTY_POOP, PROPERTY_STATUS, PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
EPICSConnection(String name, DataType dataType, EPICSConnector connector)	Constructor for EPICSConnection.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(String pName, PropertyChangeListener l)	addPropertyChangeListener.
void	connectionChanged(gov.aps.jca.event.ConnectionEvent ev)
void	destroy()	destroy.
void	fireMetaDataChange(MetaData md)	fireMetaDataChange.
void	fireValueChange(gov.aps.jca.event.MonitorEvent ev)	fireValueChange.
gov.aps.jca.Channel	getChannel()	Getter for the field channel.
EPICSConnector	getConnector()	Returns Connector object responsible for this connection.
DataType	getDataType()	getDataType.
Poop<T,gov.aps.jca.dbr.DBR>	getLastPoop()	getLastPoop.
T	getLastValue()	Returns value from last Poop converted to data type of the connection, if possible.
MetaData	getMetaData()	getMetaData.
void	getMetaDataAsync(PropertyChangeListener l)	getMetaDataAsync.
String	getName()	Returns remote name for this connection.
Poop<T,gov.aps.jca.dbr.DBR>	getPoop()	getPoop.
Status	getStatus()	getStatus.
T	getValue()	Synchronously obtains remote value and returns it.
Request<EPICSConnector>	getValue(ResponseListener<EPICSConnector> l)	getValue.
boolean	hasLastPoop()	hasLastPoop.
boolean	hasMonitor()	hasMonitor.
boolean	isConnected()	isConnected.
boolean	isDestroyed()	Returns true after destroy method was called.
boolean	isReady()	Returns true, when this connection object is connected and has received at least one remote update.
void	removePropertyChangeListener(String pName, PropertyChangeListener l)	removePropertyChangeListener.
void	setValue(T value)	setValue.
Request<EPICSConnector>	setValue(T value, ResponseListener<EPICSConnector> l)	setValue.
String	toString()
void	waitTillConnected()	It will block this call until this connection is connected or timeout occurs and connection fails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EPICSConnection

public EPICSConnection(String name,
 DataType dataType,
 EPICSConnector connector)
                throws IllegalArgumentException,
IllegalStateException,
gov.aps.jca.CAException

Constructor for EPICSConnection.

Parameters:

name - a String object

dataType - a DataType object

connector - a EPICSConnector object

Throws:

IllegalArgumentException - if any.

IllegalStateException - if any.

gov.aps.jca.CAException - if any.

Method Details

connectionChanged

public void connectionChanged(gov.aps.jca.event.ConnectionEvent ev)

Specified by:

connectionChanged in interface gov.aps.jca.event.ConnectionListener

fireValueChange

public void fireValueChange(gov.aps.jca.event.MonitorEvent ev)

fireValueChange.

Parameters:

ev - a MonitorEvent object

fireMetaDataChange

public void fireMetaDataChange(MetaData md)

fireMetaDataChange.

Parameters:

md - a MetaData object

addPropertyChangeListener

public void addPropertyChangeListener(String pName,
 PropertyChangeListener l)
                               throws RemoteException

addPropertyChangeListener.

Specified by:

addPropertyChangeListener in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

pName - a String object

l - a PropertyChangeListener object

Throws:

RemoteException - if any.

removePropertyChangeListener

public void removePropertyChangeListener(String pName,
 PropertyChangeListener l)

removePropertyChangeListener.

Specified by:

removePropertyChangeListener in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

pName - a String object

l - a PropertyChangeListener object

getDataType

public DataType getDataType()

getDataType.

Specified by:

getDataType in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a DataType object

getName

public String getName()

Returns remote name for this connection.

Specified by:

getName in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

remote name

getChannel

public gov.aps.jca.Channel getChannel()

Getter for the field channel.

Returns:

a Channel object

getConnector

public EPICSConnector getConnector()

Returns Connector object responsible for this connection.

Specified by:

getConnector in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a C object

getMetaData

public MetaData getMetaData()

getMetaData.

Specified by:

getMetaData in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a MetaData object

getMetaDataAsync

public void getMetaDataAsync(PropertyChangeListener l)

getMetaDataAsync.

Specified by:

getMetaDataAsync in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

l - a PropertyChangeListener object

getValue

public T getValue()
           throws RemoteException

Synchronously obtains remote value and returns it. This call is blocked until value is returned.

Specified by:

getValue in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

remote value

Throws:

RemoteException - if retrieving value fails

getPoop

public Poop<T,gov.aps.jca.dbr.DBR> getPoop()
                                    throws RemoteException

getPoop.

Specified by:

getPoop in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a Poop object

Throws:

RemoteException - if any.

setValue

public void setValue(T value)
              throws RemoteException

setValue.

Specified by:

setValue in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

value - a T object

Throws:

RemoteException - if any.

getLastPoop

public Poop<T,gov.aps.jca.dbr.DBR> getLastPoop()

getLastPoop.

Specified by:

getLastPoop in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a Poop object

getLastValue

public T getLastValue()

Returns value from last Poop converted to data type of the connection, if possible.

Specified by:

getLastValue in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

the last value from last Poop

hasLastPoop

public boolean hasLastPoop()

hasLastPoop.

Specified by:

hasLastPoop in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a boolean

hasMonitor

public boolean hasMonitor()

hasMonitor.

Returns:

a boolean

destroy

public void destroy()

destroy.

Specified by:

destroy in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

isReady

public boolean isReady()

Returns true, when this connection object is connected and has received at least one remote update. This means that remote connection is successfully established (CONNECTED status state) and alive (no warnings, alarms or errors states in status). As remote update counts that hasLastPoop() returns true, which is consequence of least one successful get call was made or there is property listener registered on this object and remote monitor has already returned at least one monitor update.

Specified by:

isReady in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

returns true, when connection is ready to be used

isDestroyed

public boolean isDestroyed()

Returns true after destroy method was called.

Specified by:

isDestroyed in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

true after destroy method was called

isConnected

public boolean isConnected()

isConnected.

Specified by:

isConnected in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a boolean

waitTillConnected

public void waitTillConnected()

It will block this call until this connection is connected or timeout occurs and connection fails.

Specified by:

waitTillConnected in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

setValue

public Request<EPICSConnector> setValue(T value,
 ResponseListener<EPICSConnector> l)
                                 throws RemoteException

setValue.

Specified by:

setValue in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

value - a T object

l - a ResponseListener object

Returns:

a Request object

Throws:

RemoteException - if any.

getValue

public Request<EPICSConnector> getValue(ResponseListener<EPICSConnector> l)
                                 throws RemoteException

getValue.

Specified by:

getValue in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Parameters:

l - a ResponseListener object

Returns:

a Request object

Throws:

RemoteException - if any.

getStatus

public Status getStatus()

getStatus.

Specified by:

getStatus in interface Connection<EPICSConnector,T,gov.aps.jca.dbr.DBR>

Returns:

a Status object

toString

public String toString()

Overrides:

toString in class Object