org.youscope.addon.microscopeaccess

Interface AvailableDeviceDriverInternal

public interface AvailableDeviceDriverInternal

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, int accessID) Initializes a previously loaded device.
boolean	isSerialPortDriver(int accessID) Returns true if this driver communicates over a serial port.
PreInitDevicePropertyInternal[]	loadDevice(java.lang.String deviceID, int accessID) Loads the specified device driver, but yet does not initialize it.
void	unloadDevice(int accessID) Unloads a previously loaded, but yet not initialized device.

Method Detail

getDriverID

java.lang.String getDriverID()
                      throws MicroscopeDriverException

Returns the identifier of the device driver.

Returns:

Identifier of device.

Throws:

MicroscopeDriverException

getType

DeviceType getType()
            throws MicroscopeDriverException

Returns the type of this device driver.

Returns:

Type of the device.

Throws:

MicroscopeDriverException

getDescription

java.lang.String getDescription()
                         throws MicroscopeDriverException

Returns the description of the device driver.

Returns:

Description of the driver.

Throws:

MicroscopeDriverException

getLibraryID

java.lang.String getLibraryID()
                       throws MicroscopeDriverException

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

Returns:

The library name of this device.

Throws:

MicroscopeDriverException

loadDevice

PreInitDevicePropertyInternal[] loadDevice(java.lang.String deviceID,
                                           int accessID)
                                    throws MicroscopeDriverException,
                                           MicroscopeLockedException

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.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Returns:

List of properties which have to be pre-initialized.

Throws:

MicroscopeDriverException

MicroscopeLockedException

initializeDevice

void initializeDevice(DeviceSetting[] preInitSettings,
                      int accessID)
               throws MicroscopeDriverException,
                      MicroscopeLockedException

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.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeDriverException

MicroscopeLockedException

unloadDevice

void unloadDevice(int accessID)
           throws MicroscopeLockedException,
                  MicroscopeDriverException

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.

Parameters:

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeLockedException

MicroscopeDriverException

isSerialPortDriver

boolean isSerialPortDriver(int accessID)
                    throws MicroscopeLockedException,
                           MicroscopeDriverException

Returns true if this driver communicates over a serial port. Should only be called when the respective device was already loaded. If device is not loaded, throws a driver exception.

Parameters:

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Returns:

True if driver uses a serial port, false otherwise.

Throws:

MicroscopeLockedException

MicroscopeDriverException