org.youscope.plugin.microscopeaccess

Class SerialDeviceImpl

java.lang.Object

org.youscope.plugin.microscopeaccess.SerialDeviceImpl

All Implemented Interfaces:

java.lang.Comparable<org.youscope.plugin.microscopeaccess.DeviceImpl>, DeviceInternal, SerialDeviceInternal

public class SerialDeviceImpl
extends java.lang.Object
implements SerialDeviceInternal

Author:

Moritz Lang

Field Summary

Fields

Modifier and Type	Field and Description
protected org.youscope.plugin.microscopeaccess.MicroscopeImpl	microscope
protected java.util.Hashtable<java.lang.String,PropertyImpl>	properties

Method Summary

Modifier and Type	Method and Description
int	compareTo(org.youscope.plugin.microscopeaccess.DeviceImpl o)
void	deviceStateModified() Called whenever a device performed an action.
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.
PropertyImpl[]	getEditableProperties() Returns a list of all editable properties of this device.
double	getExplicitDelay() Returns the explicit device delay in ms.
java.util.Date	getInitializationTime() Returns the time when the device was initialized.
java.lang.String	getLibraryID() Returns the library name in which this device's driver is defined.
PropertyImpl[]	getProperties() Returns a list of all properties of this device.
PropertyImpl	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.
protected void	initializeDevice(int accessID) Initializes device
protected PropertyImpl	initializeProperty(java.lang.String propertyID)
void	sendCommand(java.lang.String command, int accessID) Sends a serial command to the corresponding port
void	setExplicitDelay(double delay, int accessID) Sets the explicit delay in ms.
void	waitForDevice() Waits for the device to have finished its latest actions before returning.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.youscope.addon.microscopeaccess.DeviceInternal

getDeviceID, getDriverID, getEditableProperties, getExplicitDelay, getInitializationTime, getLibraryID, getProperties, getProperty, getType, setExplicitDelay, waitForDevice

Field Detail

microscope

protected final org.youscope.plugin.microscopeaccess.MicroscopeImpl microscope

properties

protected final java.util.Hashtable<java.lang.String,PropertyImpl> properties

Method Detail

initializeDevice

protected void initializeDevice(int accessID)
                         throws MicroscopeException

Initializes device

Throws:

MicroscopeException

sendCommand

public void sendCommand(java.lang.String command,
                        int accessID)
                 throws MicroscopeLockedException,
                        MicroscopeException,
                        java.lang.InterruptedException

Sends a serial command to the corresponding port

Specified by:

sendCommand in interface SerialDeviceInternal

Parameters:

command - The command to send. Use only ASCI

accessID - The access ID.

Throws:

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

initializeProperty

protected PropertyImpl initializeProperty(java.lang.String propertyID)
                                   throws MicroscopeException

Throws:

MicroscopeException

getInitializationTime

public java.util.Date getInitializationTime()

Description copied from interface: DeviceInternal

Returns the time when the device was initialized.

Specified by:

getInitializationTime in interface DeviceInternal

Returns:

Time when device was initialized.

getDeviceID

public java.lang.String getDeviceID()

Description copied from interface: DeviceInternal

Returns the name of the device.

Specified by:

getDeviceID in interface DeviceInternal

Returns:

Name of device.

getType

public DeviceType getType()

Description copied from interface: DeviceInternal

Returns the type of this device.

Specified by:

getType in interface DeviceInternal

Returns:

Type of the device.

getEditableProperties

public PropertyImpl[] getEditableProperties()

Description copied from interface: DeviceInternal

Returns a list of all editable properties of this device.

Specified by:

getEditableProperties in interface DeviceInternal

Returns:

List of editable properties.

getProperties

public PropertyImpl[] getProperties()

Description copied from interface: DeviceInternal

Returns a list of all properties of this device.

Specified by:

getProperties in interface DeviceInternal

Returns:

List of properties.

getProperty

public PropertyImpl getProperty(java.lang.String propertyID)
                         throws DeviceException

Description copied from interface: DeviceInternal

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

Specified by:

getProperty in interface DeviceInternal

Parameters:

propertyID - Name of the property.

Returns:

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

Throws:

DeviceException

getLibraryID

public java.lang.String getLibraryID()

Description copied from interface: DeviceInternal

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

Specified by:

getLibraryID in interface DeviceInternal

Returns:

Name of device driver library.

getDriverID

public java.lang.String getDriverID()

Description copied from interface: DeviceInternal

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

Specified by:

getDriverID in interface DeviceInternal

Returns:

Device's driver identifier.

getExplicitDelay

public double getExplicitDelay()

Description copied from interface: DeviceInternal

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

Specified by:

getExplicitDelay in interface DeviceInternal

Returns:

Device delay in ms.

setExplicitDelay

public void setExplicitDelay(double delay,
                             int accessID)
                      throws MicroscopeException,
                             MicroscopeLockedException

Description copied from interface: DeviceInternal

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

Specified by:

setExplicitDelay in interface DeviceInternal

Parameters:

delay - Delay iin ms.

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

Throws:

MicroscopeException

MicroscopeLockedException

compareTo

public int compareTo(org.youscope.plugin.microscopeaccess.DeviceImpl o)

Specified by:

compareTo in interface java.lang.Comparable<org.youscope.plugin.microscopeaccess.DeviceImpl>

waitForDevice

public void waitForDevice()
                   throws MicroscopeException,
                          java.lang.InterruptedException

Description copied from interface: DeviceInternal

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).

Specified by:

waitForDevice in interface DeviceInternal

Throws:

MicroscopeException

java.lang.InterruptedException

deviceStateModified

public void deviceStateModified()

Called whenever a device performed an action.