Package org.eclipse.scanning.event.remote

Class RunnableDeviceServiceProxy

java.lang.Object

org.eclipse.scanning.event.remote.RunnableDeviceServiceProxy

All Implemented Interfaces:

AutoCloseable, IRunnableDeviceService, IConnection, IPositionerService

public class RunnableDeviceServiceProxy
extends Object
implements IRunnableDeviceService

Field Summary

Fields

Modifier and Type	Field	Description
protected IEventService	eservice
protected URI	uri

Constructor Summary

Constructors

Constructor	Description
RunnableDeviceServiceProxy()

Method Summary

Modifier and Type	Method	Description
IPositioner	createPositioner(String name)	This method sets the value of the scannables named to this position.
IPositioner	createPositioner(INameable parent)	This method sets the value of the scannables named to this position.
void	disconnect()	Call to disconnect any resources which we no longer need.
IScannableDeviceService	getDeviceConnectorService()	Deprecated, for removal: This API element is subject to removal in a future version.
Collection<DeviceInformation<?>>	getDeviceInformation()	Get the information for all the runnable devices currently created.
DeviceInformation<?>	getDeviceInformation(String name)	Get the information for the named runnable device.
Collection<DeviceInformation<?>>	getDeviceInformation(DeviceRole role)	Get the information for all the runnable devices currently created with a specific role.
Collection<DeviceInformation<?>>	getDeviceInformationIncludingNonAlive()	Get the information for all the runnable devices currently created.
protected IEventService	getEventService()
<T> IRunnableDevice<T>	getRunnableDevice(String name)	Get a runnable device by name.
<T> IRunnableDevice<T>	getRunnableDevice(String name, IPublisher<ScanBean> publisher)	Get a runnable device by name.
Collection<String>	getRunnableDeviceNames()	A collection of the current named runnable devices which may be retrieved and configured.
URI	getUri()
void	init()
boolean	isConnected()	Returns whether this connection is connected.
<T> void	register(IRunnableDevice<T> device)	Used to register a device.
void	setConnected(boolean isConnected)
void	setEventService(IEventService eservice)
void	setUri(URI uri)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scanning.api.event.core.IConnection

close

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableDeviceService

getActiveScanner

Field Details

eservice

protected IEventService eservice

uri

protected URI uri

Constructor Details

RunnableDeviceServiceProxy

public RunnableDeviceServiceProxy()

Method Details

init

public void init()
          throws EventException

Throws:

EventException

disconnect

public void disconnect()
                throws EventException

Description copied from interface: IConnection

Call to disconnect any resources which we no longer need. The resource may have timed out so it might not be connected, in that case it silently returns. Note, that the method IConnection.close(), inherited from AutoCloseable calls this method, which means that if an object of a class implementing IConnection is used with a try-with-resources block this method will be called automatically when exiting that block.

Specified by:

disconnect in interface IConnection

Throws:

EventException - if resource could not be disconnected.

createPositioner

public IPositioner createPositioner(INameable parent)
                             throws ScanningException

Description copied from interface: IPositionerService

This method sets the value of the scannables named to this position. It takes into account the levels of the scannbles. It is blocking until all the scannables have reached the desired location.

Specified by:

createPositioner in interface IPositionerService

Parameters:

parent - the parent device

Returns:

the positioner

Throws:

ScanningException

createPositioner

public IPositioner createPositioner(String name)
                             throws ScanningException

Description copied from interface: IPositionerService

This method sets the value of the scannables named to this position. It takes into account the levels of the scannbles. It is blocking until all the scannables have reached the desired location.

Specified by:

createPositioner in interface IPositionerService

Parameters:

name - the name of the positioner

Returns:

the positioner

Throws:

ScanningException

getRunnableDevice

public <T> IRunnableDevice<T> getRunnableDevice(String name)
                                         throws ScanningException

Description copied from interface: IRunnableDeviceService

Get a runnable device by name. If the device was created by spring it may need configuring before use. If the device was added to the service after a createRunnableDevice(...) call, it will already be configured.

Specified by:

getRunnableDevice in interface IRunnableDeviceService

Parameters:

name -

Returns:

named runnable device

Throws:

ScanningException

getRunnableDevice

public <T> IRunnableDevice<T> getRunnableDevice(String name,
 IPublisher<ScanBean> publisher)
                                         throws ScanningException

Description copied from interface: IRunnableDeviceService

Get a runnable device by name. If the device was created by spring it may need configuring before use. If the device was added to the service after a createRunnableDevice(...) call, it will already be configured.

Specified by:

getRunnableDevice in interface IRunnableDeviceService

Parameters:

name -

publisher - used for a particular run of the device. This must be set with care as only one publisher may be active on a device at a time.

Returns:

named runnable device

Throws:

ScanningException

getRunnableDeviceNames

public Collection<String> getRunnableDeviceNames()
                                          throws ScanningException

Description copied from interface: IRunnableDeviceService

A collection of the current named runnable devices which may be retrieved and configured.

Specified by:

getRunnableDeviceNames in interface IRunnableDeviceService

Returns:

devices

Throws:

ScanningException

getDeviceConnectorService

@Deprecated(since="GDA 9.33",
            forRemoval=true)
public IScannableDeviceService getDeviceConnectorService()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IRunnableDeviceService

Get the service being used to connect this service to the underlying hardware devices.

Specified by:

getDeviceConnectorService in interface IRunnableDeviceService

Returns:

connection service

getDeviceInformationIncludingNonAlive

public Collection<DeviceInformation<?>> getDeviceInformationIncludingNonAlive()
                                                                       throws ScanningException

Description copied from interface: IRunnableDeviceService

Get the information for all the runnable devices currently created. Will attempt to get device information that is potentially held on the device even if the device is not alive.

Specified by:

getDeviceInformationIncludingNonAlive in interface IRunnableDeviceService

Returns:

information for all the runnable devices currently created

Throws:

ScanningException

getDeviceInformation

public Collection<DeviceInformation<?>> getDeviceInformation()
                                                      throws ScanningException

Description copied from interface: IRunnableDeviceService

Get the information for all the runnable devices currently created. Will not get device information that is potentially held on the device if the device is not alive.

Specified by:

getDeviceInformation in interface IRunnableDeviceService

Returns:

information for all the runnable devices currently created

Throws:

ScanningException

getDeviceInformation

public Collection<DeviceInformation<?>> getDeviceInformation(DeviceRole role)
                                                      throws ScanningException

Description copied from interface: IRunnableDeviceService

Get the information for all the runnable devices currently created with a specific role. Will not get device information that is potentially held on the device if the device is not alive.

Specified by:

getDeviceInformation in interface IRunnableDeviceService

Returns:

device info

Throws:

ScanningException

getDeviceInformation

public DeviceInformation<?> getDeviceInformation(String name)
                                          throws ScanningException

Description copied from interface: IRunnableDeviceService

Get the information for the named runnable device.

Specified by:

getDeviceInformation in interface IRunnableDeviceService

Returns:

information for the named device

Throws:

ScanningException

register

public <T> void register(IRunnableDevice<T> device)

Description copied from interface: IRunnableDeviceService

Used to register a device. This is required so that spring may create detectors and call the register method by telling the detector to register itself.

Specified by:

register in interface IRunnableDeviceService

Parameters:

device -

getEventService

protected IEventService getEventService()

setEventService

public void setEventService(IEventService eservice)

getUri

public URI getUri()

setUri

public void setUri(URI uri)

isConnected

public boolean isConnected()

Description copied from interface: IConnection

Returns whether this connection is connected. This method returns true until disconnect is called, even if the connection is created lazily.

Specified by:

isConnected in interface IConnection

Returns:

true if connected, false otherwise

setConnected

public void setConnected(boolean isConnected)