org.youscope.server

Class AvailableDeviceDriverRMI

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.youscope.server.AvailableDeviceDriverRMI

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, AvailableDeviceDriver

public class AvailableDeviceDriverRMI
extends java.rmi.server.UnicastRemoteObject
implements AvailableDeviceDriver

Author:

langmo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	accessID

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AvailableDeviceDriverRMI(AvailableDeviceDriverInternal deviceDriver, int accessID)

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.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

accessID

protected int accessID

Constructor Detail

AvailableDeviceDriverRMI

protected AvailableDeviceDriverRMI(AvailableDeviceDriverInternal deviceDriver,
                                   int accessID)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

getDriverID

public java.lang.String getDriverID()
                             throws MicroscopeDriverException

Description copied from interface: AvailableDeviceDriver

Returns the identifier of the device driver.

Specified by:

getDriverID in interface AvailableDeviceDriver

Returns:

Identifier of device.

Throws:

MicroscopeDriverException

getType

public DeviceType getType()
                   throws MicroscopeDriverException

Description copied from interface: AvailableDeviceDriver

Returns the type of this device driver.

Specified by:

getType in interface AvailableDeviceDriver

Returns:

Type of the device.

Throws:

MicroscopeDriverException

getDescription

public java.lang.String getDescription()
                                throws MicroscopeDriverException

Description copied from interface: AvailableDeviceDriver

Returns the description of the device driver.

Specified by:

getDescription in interface AvailableDeviceDriver

Returns:

Description of the driver.

Throws:

MicroscopeDriverException

getLibraryID

public java.lang.String getLibraryID()
                              throws MicroscopeDriverException

Description copied from interface: AvailableDeviceDriver

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

Specified by:

getLibraryID in interface AvailableDeviceDriver

Returns:

The library name of this device.

Throws:

MicroscopeDriverException

isSerialPortDriver

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

Description copied from interface: AvailableDeviceDriver

Returns true if this driver communicates over a serial port.

Specified by:

isSerialPortDriver in interface AvailableDeviceDriver

Returns:

True if driver uses a serial port, false otherwise.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

MicroscopeDriverException

loadDevice

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

Description copied from interface: AvailableDeviceDriver

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.

Specified by:

loadDevice in interface AvailableDeviceDriver

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

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

Description copied from interface: AvailableDeviceDriver

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.

Specified by:

initializeDevice in interface AvailableDeviceDriver

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

unloadDevice

public void unloadDevice()
                  throws MicroscopeLockedException,
                         MicroscopeDriverException

Description copied from interface: AvailableDeviceDriver

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.

Specified by:

unloadDevice in interface AvailableDeviceDriver

Throws:

MicroscopeLockedException

MicroscopeDriverException