org.youscope.common.microscope

Interface AvailableDeviceDriver

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

AvailableDeviceDriverRMI

public interface AvailableDeviceDriver
extends java.rmi.Remote

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description of the device driver.
java.lang.String	getDriverID() Returns the identifier of the device driver.
java.lang.String	getLibraryID() Returns the name of the library where this device is implemented.
DeviceType	getType() Returns the type of this device driver.
void	initializeDevice(DeviceSetting[] preInitSettings) Initializes a previously loaded device.
boolean	isSerialPortDriver() Returns true if this driver communicates over a serial port.
PreInitDeviceProperty[]	loadDevice(java.lang.String deviceID) Loads the specified device driver, but yet does not initialize it.
void	unloadDevice() Unloads a previously loaded, but yet not initialized device.

Method Detail

getDriverID

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

Returns the identifier of the device driver.

Returns:

Identifier of device.

Throws:

MicroscopeDriverException

java.rmi.RemoteException

getType

DeviceType getType()
            throws MicroscopeDriverException,
                   java.rmi.RemoteException

Returns the type of this device driver.

Returns:

Type of the device.

Throws:

MicroscopeDriverException

java.rmi.RemoteException

getDescription

java.lang.String getDescription()
                         throws MicroscopeDriverException,
                                java.rmi.RemoteException

Returns the description of the device driver.

Returns:

Description of the driver.

Throws:

MicroscopeDriverException

java.rmi.RemoteException

getLibraryID

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

Returns the name of the library where this device is implemented.

Returns:

The library name of this device.

Throws:

MicroscopeDriverException

java.rmi.RemoteException

loadDevice

PreInitDeviceProperty[] loadDevice(java.lang.String deviceID)
                            throws MicroscopeDriverException,
                                   MicroscopeLockedException,
                                   java.rmi.RemoteException

Loads the specified device driver, but yet does not initialize it. Returns a (possibly empty) list of properties for this device driver which have to be set when initializing the driver. Should be followed by a call to initializeDevice or unloadDevice.

Parameters:

deviceID - The ID under which the device should be initialized.

Returns:

List of properties which have to be pre-initialized.

Throws:

MicroscopeDriverException

MicroscopeLockedException

java.rmi.RemoteException

initializeDevice

void initializeDevice(DeviceSetting[] preInitSettings)
               throws MicroscopeDriverException,
                      MicroscopeLockedException,
                      java.rmi.RemoteException

Initializes a previously loaded device. The device can then be used. The device settings should correspond (in the same order) to the PreInitDevicePropertyInternal device settings returned by the previous call to loadDevice. Throws an error if called before loadDevice was called. Load device has to be called each time before calling this function.

Parameters:

preInitSettings - Device properties necessary to be set prior to the initialization of the device. Can be null or an empty array if no settings are necessary.

Throws:

MicroscopeDriverException

MicroscopeLockedException

java.rmi.RemoteException

unloadDevice

void unloadDevice()
           throws MicroscopeLockedException,
                  MicroscopeDriverException,
                  java.rmi.RemoteException

Unloads a previously loaded, but yet not initialized device. Should be called to clean up if a device was loaded, but it was decided to not initialize it. Does nothing if currently no device is loaded.

Throws:

MicroscopeLockedException

MicroscopeDriverException

java.rmi.RemoteException

isSerialPortDriver

boolean isSerialPortDriver()
                    throws MicroscopeLockedException,
                           MicroscopeDriverException,
                           java.rmi.RemoteException

Returns true if this driver communicates over a serial port.

Returns:

True if driver uses a serial port, false otherwise.

Throws:

MicroscopeLockedException

MicroscopeDriverException

java.rmi.RemoteException