Package org.scictrl.mp.orbitcorrect.epics

Class EDataConnectorD

java.lang.Object

org.scictrl.mp.orbitcorrect.epics.EAbstractDataConnector<Double>

org.scictrl.mp.orbitcorrect.epics.EDataConnectorD

All Implemented Interfaces:

IDataConnector<Double>, IWriteConnector<Double>

public class EDataConnectorD
extends EAbstractDataConnector<Double>
implements IWriteConnector<Double>

EDataConnectorD class.

Author:

igor@scictrl.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.scictrl.mp.orbitcorrect.model.IDataConnector

IDataConnector.PushStrategy, IDataConnector.UpdateStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected org.scictrl.csshell.epics.EPICSConnection<Double>	connection	remote connection/.

Fields inherited from class org.scictrl.mp.orbitcorrect.epics.EAbstractDataConnector

element, engine

Constructor Summary

Constructors

Constructor	Description
EDataConnectorD(EControlSystemEngine engine, IBindedElement<Double> element, org.scictrl.csshell.epics.EPICSConnection<Double> connection)	Constructor for EDataConnectorD.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys remote connection and release all relevant resources.
Double	get()	Gets value from remote data source and returns it.
org.scictrl.csshell.epics.EPICSConnection<Double>	getConnection()	Getter for the field connection.
String	getFormat()	getFormat.
long	getLatestReceivedTimestamp()	getLatestReceivedTimestamp.
Double	getLatestReceivedValue()	Returns latest position delivered to the connector by way of event updates.
double	getMaxValue()	getMaxValue.
double	getMinValue()	getMinValue.
String	getName()	getName.
boolean	isReady()	A quick tests of connection and device by examining locally available data.
void	set(Double d)	set.
boolean	test()	Tests connection and device if it is in usable state.

Methods inherited from class org.scictrl.mp.orbitcorrect.epics.EAbstractDataConnector

dataType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scictrl.mp.orbitcorrect.model.IDataConnector

dataType

Field Details

connection

protected org.scictrl.csshell.epics.EPICSConnection<Double> connection

remote connection/.

Constructor Details

EDataConnectorD

public EDataConnectorD(EControlSystemEngine engine,
 IBindedElement<Double> element,
 org.scictrl.csshell.epics.EPICSConnection<Double> connection)
                throws Exception

Constructor for EDataConnectorD.

Parameters:

engine - a EControlSystemEngine object

element - a IBindedElement object

connection - a EPICSConnection object

Throws:

Exception - if fails

Method Details

get

public Double get()
           throws Exception

Gets value from remote data source and returns it.

Specified by:

get in interface IDataConnector<Double>

Returns:

value from remote data source.

Throws:

Exception - if remote get fails

getLatestReceivedValue

public Double getLatestReceivedValue()

Returns latest position delivered to the connector by way of event updates.

Specified by:

getLatestReceivedValue in interface IDataConnector<Double>

Returns:

lates data update value

destroy

public void destroy()

Destroys remote connection and release all relevant resources.

Specified by:

destroy in interface IDataConnector<Double>

test

public boolean test()

Tests connection and device if it is in usable state. This may include making remote calls and checking remote status or other values.

Specified by:

test in interface IDataConnector<Double>

Returns:

true if connector can be used

isReady

public boolean isReady()

A quick tests of connection and device by examining locally available data. It is suppose to be lightweight method, avoiding making remote calls and should exit quickly.

Specified by:

isReady in interface IDataConnector<Double>

Returns:

true if connector can be used

getFormat

public String getFormat()
                 throws ControlSystemException

getFormat.

Specified by:

getFormat in interface IDataConnector<Double>

Returns:

a String object

Throws:

ControlSystemException - if any.

getLatestReceivedTimestamp

public long getLatestReceivedTimestamp()

getLatestReceivedTimestamp.

Specified by:

getLatestReceivedTimestamp in interface IDataConnector<Double>

Returns:

a long

getName

public String getName()

getName.

Specified by:

getName in interface IDataConnector<Double>

Returns:

a String object

getMaxValue

public double getMaxValue()
                   throws ControlSystemException

getMaxValue.

getMaxValue.

Specified by:

getMaxValue in interface IWriteConnector<Double>

Returns:

a double

Throws:

ControlSystemException - if any.

getMinValue

public double getMinValue()
                   throws ControlSystemException

getMinValue.

getMinValue method comment.

Specified by:

getMinValue in interface IWriteConnector<Double>

Returns:

a double

Throws:

ControlSystemException - if any.

set

public void set(Double d)
         throws ControlSystemException

set.

Specified by:

set in interface IWriteConnector<Double>

Parameters:

d - a T object

Throws:

ControlSystemException - if any.

getConnection

public org.scictrl.csshell.epics.EPICSConnection<Double> getConnection()

Getter for the field connection.

Returns:

a EPICSConnection object