org.youscope.addon.microscopeaccess

Interface MicroscopeInternal

public interface MicroscopeInternal

Internal interface of the microscope. Non-remote, and all functions changing the microscope state have to be provided with the access ID.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
void	addConfigurationListener(MicroscopeConfigurationListener listener) Adds a listener which gets informed if the configuration of the microscope changes.
void	addMessageListener(MessageListener listener) Adds a listener which gets informed when the state of the microscope changes.
void	applyDeviceSetting(DeviceSetting setting, int accessID) Sets the given device property to the given value.
void	applyDeviceSettingAsync(DeviceSetting setting, int accessID) Sets the given device property to the given value.
void	applyDeviceSettings(DeviceSetting[] settings, int accessID) Sets the given device properties to the given values.
void	applyDeviceSettingsAsync(DeviceSetting[] settings, int accessID) Sets the given device properties to the given values.
void	emergencyStop() Stops the XY stage of the microscope and prevents ASAP any other thread to obtain access to the microscope.
AutoFocusDeviceInternal	getAutoFocusDevice() Returns the current default auto-focus device.
AutoFocusDeviceInternal	getAutoFocusDevice(java.lang.String deviceID) Returns the auto-focus device with the given name.
AutoFocusDeviceInternal[]	getAutoFocusDevices() Returns a list of all installed auto-focus devices.
CameraDeviceInternal	getCameraDevice() Returns the current default camera device.
CameraDeviceInternal	getCameraDevice(java.lang.String name) Returns the camera device with the given name.
CameraDeviceInternal[]	getCameraDevices() Returns all currently installed camera devices.
DeviceInternal	getDevice(java.lang.String name) Returns the device of this microscope with the given name.
DeviceLoaderInternal	getDeviceLoader() Returns a class with which the device driver settings of the microscope can be modified.
DeviceInternal[]	getDevices() Returns a list of all devices of this microscope, or an empty list if this microscope does not have any devices.
DeviceInternal[]	getDevices(DeviceType type) Returns a list of all devices of the given type, or an empty list if no such device is configured.
FocusDeviceInternal	getFocusDevice() Returns the current default focus device.
FocusDeviceInternal	getFocusDevice(java.lang.String deviceID) Returns the focus device with the given name.
FocusDeviceInternal[]	getFocusDevices() Returns a list of all installed focus devices.
MicroscopeConfigurationInternal	getMicroscopeConfiguration() Returns an interface with which general configuration settings of the microscope can be changed.
ShutterDeviceInternal	getShutterDevice() Returns the current default shutter device.
ShutterDeviceInternal	getShutterDevice(java.lang.String deviceID) Returns the shutter device with the given name.
ShutterDeviceInternal[]	getShutterDevices() Returns a list of all installed shutter devices.
StageDeviceInternal	getStageDevice() Returns the current default stage device.
StageDeviceInternal	getStageDevice(java.lang.String deviceID) Returns the stage device with the given name.
StageDeviceInternal[]	getStageDevices() Returns all installed stage devices.
StateDeviceInternal	getStateDevice(java.lang.String name) Returns the state device with the given name.
StateDeviceInternal[]	getStateDevices() Returns a list of all installed state devices.
void	initializeMicroscope(int accessID) Initializes the microscope.
boolean	isEmergencyStopped() Returns true if microscope is currently in the emergency-stop state.
void	lockExclusiveWrite(int accessID) Locks the microscope for a longer time (e.g.
void	removeConfigurationListener(MicroscopeConfigurationListener listener) Removes a previously added listener
void	removeMessageListener(MessageListener listener) Removes a previously added listener.
void	resetEmergencyStop() Resets the emergency-stop state, such that microscope can be accessed again.
void	setAutoFocusDevice(java.lang.String deviceID, int accessID) Sets the default auto-focus device.
void	setCameraDevice(java.lang.String cameraDevice, int accessID) Sets the current default camera device.
void	setFocusDevice(java.lang.String deviceID, int accessID) Sets the default focus device.
void	setShutterDevice(java.lang.String deviceID, int accessID) Sets the default shutter device.
void	setStageDevice(java.lang.String deviceID, int accessID) Sets the default stage device.
void	uninitializeMicroscope(int accessID) Uninitializes the microscope.
void	unlockExclusiveWrite(int accessID) Unlocks the previously acquired lock.

Method Detail

getDeviceLoader

DeviceLoaderInternal getDeviceLoader()
                              throws java.lang.UnsupportedOperationException

Returns a class with which the device driver settings of the microscope can be modified.

Returns:

Interface to modify device driver settings.

Throws:

java.lang.UnsupportedOperationException - If modifying device driver settings is not supported.

getMicroscopeConfiguration

MicroscopeConfigurationInternal getMicroscopeConfiguration()

Returns an interface with which general configuration settings of the microscope can be changed.

Returns:

General configuration settings.

getDevices

DeviceInternal[] getDevices()

Returns a list of all devices of this microscope, or an empty list if this microscope does not have any devices.

Returns:

List of all devices.

getDevices

DeviceInternal[] getDevices(DeviceType type)

Returns a list of all devices of the given type, or an empty list if no such device is configured.

Parameters:

type - Type of the devices to query for.

Returns:

List of all devices of the given type.

getDevice

DeviceInternal getDevice(java.lang.String name)
                  throws DeviceException

Returns the device of this microscope with the given name.

Parameters:

name - Name of the device.

Returns:

Device with the given name.

Throws:

DeviceException - Thrown if the given device could not be found.

getFocusDevice

FocusDeviceInternal getFocusDevice()
                            throws DeviceException

Returns the current default focus device.

Returns:

Focus device.

Throws:

DeviceException

getFocusDevices

FocusDeviceInternal[] getFocusDevices()

Returns a list of all installed focus devices.

Returns:

List of all installed focus devices.

getFocusDevice

FocusDeviceInternal getFocusDevice(java.lang.String deviceID)
                            throws DeviceException

Returns the focus device with the given name.

Parameters:

deviceID - Name of focus device.

Returns:

Focus device.

Throws:

DeviceException

getAutoFocusDevice

AutoFocusDeviceInternal getAutoFocusDevice()
                                    throws DeviceException

Returns the current default auto-focus device.

Returns:

Current auto-focus device.

Throws:

DeviceException

getAutoFocusDevices

AutoFocusDeviceInternal[] getAutoFocusDevices()

Returns a list of all installed auto-focus devices.

Returns:

List of all installed auto-focus devices.

getAutoFocusDevice

AutoFocusDeviceInternal getAutoFocusDevice(java.lang.String deviceID)
                                    throws DeviceException

Returns the auto-focus device with the given name.

Parameters:

deviceID - ID of the auto-focus device.

Returns:

The auto-focus device with the given ID.

Throws:

DeviceException

setFocusDevice

void setFocusDevice(java.lang.String deviceID,
                    int accessID)
             throws DeviceException,
                    MicroscopeLockedException

Sets the default focus device.

Parameters:

deviceID - Name of focus device.

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

Throws:

DeviceException

MicroscopeLockedException

setAutoFocusDevice

void setAutoFocusDevice(java.lang.String deviceID,
                        int accessID)
                 throws DeviceException,
                        MicroscopeLockedException

Sets the default auto-focus device.

Parameters:

deviceID - Name of auto-focus device.

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

Throws:

DeviceException

MicroscopeLockedException

setShutterDevice

void setShutterDevice(java.lang.String deviceID,
                      int accessID)
               throws DeviceException,
                      MicroscopeLockedException

Sets the default shutter device.

Parameters:

deviceID - Name of shutter device.

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

Throws:

DeviceException

MicroscopeLockedException

getShutterDevice

ShutterDeviceInternal getShutterDevice()
                                throws DeviceException

Returns the current default shutter device.

Returns:

shutter device.

Throws:

DeviceException

getShutterDevices

ShutterDeviceInternal[] getShutterDevices()

Returns a list of all installed shutter devices.

Returns:

List of all installed shutter devices.

getShutterDevice

ShutterDeviceInternal getShutterDevice(java.lang.String deviceID)
                                throws DeviceException

Returns the shutter device with the given name.

Parameters:

deviceID - Name of shutter device.

Returns:

shutter device.

Throws:

DeviceException

getStageDevice

StageDeviceInternal getStageDevice()
                            throws DeviceException

Returns the current default stage device.

Returns:

Stage device.

Throws:

DeviceException

getStageDevices

StageDeviceInternal[] getStageDevices()

Returns all installed stage devices.

Returns:

List of all stage devices.

getStageDevice

StageDeviceInternal getStageDevice(java.lang.String deviceID)
                            throws DeviceException

Returns the stage device with the given name.

Parameters:

deviceID - Name of stage device.

Returns:

Stage device.

Throws:

DeviceException

setStageDevice

void setStageDevice(java.lang.String deviceID,
                    int accessID)
             throws DeviceException,
                    MicroscopeLockedException

Sets the default stage device.

Parameters:

deviceID - Name of stage device.

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

Throws:

DeviceException

MicroscopeLockedException

getCameraDevice

CameraDeviceInternal getCameraDevice()
                              throws DeviceException

Returns the current default camera device.

Returns:

Device of the camera.

Throws:

DeviceException

setCameraDevice

void setCameraDevice(java.lang.String cameraDevice,
                     int accessID)
              throws DeviceException,
                     MicroscopeLockedException

Sets the current default camera device.

Parameters:

cameraDevice - Name of the camera device which should be the default device.

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

Throws:

DeviceException

MicroscopeLockedException

getCameraDevices

CameraDeviceInternal[] getCameraDevices()

Returns all currently installed camera devices.

Returns:

All installed camera devices.

getCameraDevice

CameraDeviceInternal getCameraDevice(java.lang.String name)
                              throws DeviceException

Returns the camera device with the given name.

Parameters:

name - Name of the camera device.

Returns:

Device of the camera.

Throws:

DeviceException

applyDeviceSetting

void applyDeviceSetting(DeviceSetting setting,
                        int accessID)
                 throws SettingException,
                        MicroscopeLockedException,
                        MicroscopeException,
                        java.lang.InterruptedException

Sets the given device property to the given value. Does synchronize to the devices afterwards.

Parameters:

setting - Structure containing device, property and value configuration.

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

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

applyDeviceSettings

void applyDeviceSettings(DeviceSetting[] settings,
                         int accessID)
                  throws SettingException,
                         MicroscopeLockedException,
                         MicroscopeException,
                         java.lang.InterruptedException

Sets the given device properties to the given values. Same as calling setDeviceSetting for every element in the array, except that the microscope is locked during the whole procedure, thus either all or none of the settings is set. Does synchronize to the devices afterwards.

Parameters:

settings - Array of structures containing device, property and value configurations.

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

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

applyDeviceSettingAsync

void applyDeviceSettingAsync(DeviceSetting setting,
                             int accessID)
                      throws SettingException,
                             MicroscopeLockedException,
                             MicroscopeException,
                             java.lang.InterruptedException

Sets the given device property to the given value. Does not synchronize to the devices afterwards (i.e. does not wait for the actions to be finished).

Parameters:

setting - Structure containing device, property and value configuration.

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

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

applyDeviceSettingsAsync

void applyDeviceSettingsAsync(DeviceSetting[] settings,
                              int accessID)
                       throws SettingException,
                              MicroscopeLockedException,
                              MicroscopeException,
                              java.lang.InterruptedException

Sets the given device properties to the given values. Same as calling setDeviceSetting for every element in the array, except that the microscope is locked during the whole procedure, thus either all or none of the settings is set. Does not synchronize to the devices afterwards (i.e. does not wait for the actions to be finished).

Parameters:

settings - Array of structures containing device, property and value configurations.

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

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

lockExclusiveWrite

void lockExclusiveWrite(int accessID)
                 throws MicroscopeLockedException

Locks the microscope for a longer time (e.g. for the duration of a measurement), such that only the locker may acquire the write lock to the microscope. However, read locks may be acquired, as long as the thread is not actually acquiring the write-lock... Must be surrounded by a try-finally block with unlockExclusiveWrite in the finally statement.

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 - Thrown if microscope is already locked for a longer time by somebody else.

unlockExclusiveWrite

void unlockExclusiveWrite(int accessID)
                   throws MicroscopeLockedException

Unlocks the previously acquired lock.

Parameters:

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

Throws:

MicroscopeLockedException - Thrown if this microscope object is not the owner of the exclusive write lock.

initializeMicroscope

void initializeMicroscope(int accessID)
                   throws MicroscopeException,
                          MicroscopeLockedException,
                          java.lang.InterruptedException

Initializes the microscope.

Parameters:

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

java.lang.InterruptedException

uninitializeMicroscope

void uninitializeMicroscope(int accessID)
                     throws MicroscopeException,
                            MicroscopeLockedException,
                            java.lang.InterruptedException

Uninitializes the microscope. All loaded devices are unload.

Parameters:

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

java.lang.InterruptedException

emergencyStop

void emergencyStop()

Stops the XY stage of the microscope and prevents ASAP any other thread to obtain access to the microscope.

resetEmergencyStop

void resetEmergencyStop()

Resets the emergency-stop state, such that microscope can be accessed again.

isEmergencyStopped

boolean isEmergencyStopped()

Returns true if microscope is currently in the emergency-stop state.

Returns:

TRUE if emergency-stopped.

addMessageListener

void addMessageListener(MessageListener listener)

Adds a listener which gets informed when the state of the microscope changes.

Parameters:

listener - The listener.

removeMessageListener

void removeMessageListener(MessageListener listener)

Removes a previously added listener.

Parameters:

listener - The listener.

getStateDevice

StateDeviceInternal getStateDevice(java.lang.String name)
                            throws DeviceException

Returns the state device with the given name.

Parameters:

name - Name of state device.

Returns:

State device.

Throws:

DeviceException

getStateDevices

StateDeviceInternal[] getStateDevices()

Returns a list of all installed state devices.

Returns:

List of all installed state devices.

addConfigurationListener

void addConfigurationListener(MicroscopeConfigurationListener listener)

Adds a listener which gets informed if the configuration of the microscope changes.

Parameters:

listener - Listener to add.

removeConfigurationListener

void removeConfigurationListener(MicroscopeConfigurationListener listener)

Removes a previously added listener

Parameters:

listener - Listener to remove.