org.youscope.common.microscope

Interface Device

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

AutoFocusDevice, CameraDevice, FocusDevice, SerialDevice, ShutterDevice, StageDevice, StateDevice

public interface Device
extends java.rmi.Remote

Interface represents a physical microscope device and allows setting and getting values of it.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeviceID() Returns the name of the device.
java.lang.String	getDriverID() Returns the Identifier under which this device's driver is defined in the library.
Property[]	getEditableProperties() Returns a list of all editable properties of this device.
double	getExplicitDelay() Returns the explicit device delay in ms.
java.lang.String	getLibraryID() Returns the library name in which this device's driver is defined.
Property[]	getProperties() Returns a list of all properties of this device.
Property	getProperty(java.lang.String propertyID) Returns the property of this device with the given name, or null if this device does not have a property with this name.
DeviceType	getType() Returns the type of this device.
void	setExplicitDelay(double delay) Sets the explicit delay in ms.
void	waitForDevice() Waits for the device to have finished its latest actions before returning.

Method Detail

getDeviceID

java.lang.String getDeviceID()
                      throws java.rmi.RemoteException

Returns the name of the device.

Returns:

Name of device.

Throws:

java.rmi.RemoteException

getLibraryID

java.lang.String getLibraryID()
                       throws java.rmi.RemoteException

Returns the library name in which this device's driver is defined.

Returns:

Name of device driver library.

Throws:

java.rmi.RemoteException

getDriverID

java.lang.String getDriverID()
                      throws java.rmi.RemoteException

Returns the Identifier under which this device's driver is defined in the library.

Returns:

Device's driver identifier.

Throws:

java.rmi.RemoteException

getType

DeviceType getType()
            throws java.rmi.RemoteException

Returns the type of this device.

Returns:

Type of the device.

Throws:

java.rmi.RemoteException

getProperties

Property[] getProperties()
                  throws java.rmi.RemoteException

Returns a list of all properties of this device.

Returns:

List of properties.

Throws:

java.rmi.RemoteException

getEditableProperties

Property[] getEditableProperties()
                          throws java.rmi.RemoteException

Returns a list of all editable properties of this device.

Returns:

List of editable properties.

Throws:

java.rmi.RemoteException

getProperty

Property getProperty(java.lang.String propertyID)
              throws DeviceException,
                     java.rmi.RemoteException

Returns the property of this device with the given name, or null if this device does not have a property with this name.

Parameters:

propertyID - Name of the property.

Returns:

the property of this device with the given name, or null.

Throws:

DeviceException

java.rmi.RemoteException

waitForDevice

void waitForDevice()
            throws MicroscopeException,
                   java.rmi.RemoteException,
                   java.lang.InterruptedException

Waits for the device to have finished its latest actions before returning. Some devices give a notification if they have finished their actions, then it is waited for this notification. Devices which do not support this handshaking mechanism return immediately, even if they still complete an action, except an explicit delay greater 0 is set. For all devices with explicit delays greater zero up to two mechanisms may become active: 1) Some devices support explicit delays intrinsically. Then the set explicit delay is submitted to them and they handle this explicit delay in a driver specific way. 2) For all devices, including devices supporting the handshaking mechanism and those supporting explicit delays on their own, YouScope guarantees that at least the given time is waited since the last transmission of a command intended to change the state of the device. A changing command is a command intended to change the state of the device (e.g. setPosition(), setState(), ...), but not command intended to only read out the state of the device (e.g. getPosition(), getDeviceID(), ...), although also the latter ones might trigger some device actions for badly programmed device drivers (but usually don't). Furthermore, this mechanism only works if a device action was triggered by YouScopeClient (e.g. changes by directly manipulating the hardware or by driver-driver communication are not included).

Throws:

MicroscopeException

java.rmi.RemoteException

java.lang.InterruptedException

getExplicitDelay

double getExplicitDelay()
                 throws java.rmi.RemoteException

Returns the explicit device delay in ms. See waitForDevice() for more information.

Returns:

Device delay in ms.

Throws:

java.rmi.RemoteException

setExplicitDelay

void setExplicitDelay(double delay)
               throws MicroscopeException,
                      java.rmi.RemoteException,
                      MicroscopeLockedException

Sets the explicit delay in ms. See waitForDevice() for more information.

Parameters:

delay - Delay iin ms.

Throws:

MicroscopeException

java.rmi.RemoteException

MicroscopeLockedException