org.youscope.common.microscope

Interface Microscope

All Superinterfaces:

java.rmi.Remote

public interface Microscope
extends java.rmi.Remote

This interface represents the microscope and allows access to its devices, its configuration and its camera.

Author:

Moritz Lang

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) Sets the given device property to the given value.
void	applyDeviceSettingAsync(DeviceSetting setting) Sets the given device property to the given value.
void	applyDeviceSettings(DeviceSetting[] settings) Sets the given device properties to the given values.
void	applyDeviceSettingsAsync(DeviceSetting[] settings) 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.
AutoFocusDevice	getAutoFocusDevice() Returns the current default auto-focus device.
AutoFocusDevice	getAutoFocusDevice(java.lang.String deviceID) Returns the auto-focus device with the given name.
AutoFocusDevice[]	getAutoFocusDevices() Returns a list of all installed auto-focus devices.
CameraDevice	getCameraDevice() Returns the current default camera device.
CameraDevice	getCameraDevice(java.lang.String name) Returns the camera device with the given name.
CameraDevice[]	getCameraDevices() Returns all currently installed camera devices.
ChannelManager	getChannelManager() Returns an interface with which the current channel settings can be queried and a different channel can be set.
Device	getDevice(java.lang.String name) Returns the device of this microscope with the given name.
DeviceLoader	getDeviceLoader() Returns a class with which the device driver settings of the microscope can be modified.
Device[]	getDevices() Returns a list of all devices of this microscope, or an empty list if this microscope does not have any devices.
Device[]	getDevices(DeviceType type) Returns a list of all devices of the given type, or an empty list if no such device is configured.
FocusDevice	getFocusDevice() Returns the current default focus device.
FocusDevice	getFocusDevice(java.lang.String deviceID) Returns the focus device with the given name.
FocusDevice[]	getFocusDevices() Returns a list of all installed focus devices.
java.lang.String	getLastConfigurationWarning() Returns the warning message generated and returned when loaded the last configuration, or null if no warning appeared.
MicroscopeConfiguration	getMicroscopeConfiguration() Returns an interface with which general configuration settings of the microscope can be changed.
PixelSizeManager	getPixelSizeManager() Returns an interface with which the pixel size for different microscope settings can be queried and set.
ShutterDevice	getShutterDevice() Returns the current default shutter device.
ShutterDevice	getShutterDevice(java.lang.String deviceID) Returns the shutter device with the given name.
ShutterDevice[]	getShutterDevices() Returns a list of all installed shutter devices.
StageDevice	getStageDevice() Returns the current default stage device.
StageDevice	getStageDevice(java.lang.String deviceID) Returns the stage device with the given name.
StageDevice[]	getStageDevices() Returns all installed stage devices.
StateDevice	getStateDevice(java.lang.String name) Returns the state device with the given name.
StateDevice[]	getStateDevices() Returns a list of all installed state devices.
boolean	isEmergencyStopped() Returns true if microscope is currently in the emergency-stop state.
java.lang.String	loadConfiguration(RMIReader configurationReader) Initializes the microscope with the configuration read from the reader (e.g.
void	lockExclusiveWrite() 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	saveConfiguration(RMIWriter configurationWriter) Writes the current microscope configuration to the supplied writer (e.g.
void	setAutoFocusDevice(java.lang.String deviceID) Sets the default auto-focus device.
void	setCameraDevice(java.lang.String cameraDevice) Sets the current default camera device.
void	setFocusDevice(java.lang.String deviceID) Sets the default focus device.
void	setShutterDevice(java.lang.String deviceID) Sets the default shutter device.
void	setStageDevice(java.lang.String deviceID) Sets the default stage device.
void	uninitializeMicroscope() Uninitializes the microscope.
void	unlockExclusiveWrite() Unlocks the previously acquired lock.

Method Detail

getDeviceLoader

DeviceLoader getDeviceLoader()
                      throws java.lang.UnsupportedOperationException,
                             java.rmi.RemoteException

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.

java.rmi.RemoteException

getMicroscopeConfiguration

MicroscopeConfiguration getMicroscopeConfiguration()
                                            throws java.rmi.RemoteException

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

Returns:

General configuration settings.

Throws:

java.rmi.RemoteException

getDevices

Device[] getDevices()
             throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getDevices

Device[] getDevices(DeviceType type)
             throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getDevice

Device getDevice(java.lang.String name)
          throws DeviceException,
                 java.rmi.RemoteException

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.

java.rmi.RemoteException

getAutoFocusDevice

AutoFocusDevice getAutoFocusDevice()
                            throws DeviceException,
                                   java.rmi.RemoteException

Returns the current default auto-focus device.

Returns:

Current auto-focus device.

Throws:

DeviceException

java.rmi.RemoteException

getAutoFocusDevices

AutoFocusDevice[] getAutoFocusDevices()
                               throws java.rmi.RemoteException

Returns a list of all installed auto-focus devices.

Returns:

List of all installed auto-focus devices.

Throws:

java.rmi.RemoteException

getAutoFocusDevice

AutoFocusDevice getAutoFocusDevice(java.lang.String deviceID)
                            throws DeviceException,
                                   java.rmi.RemoteException

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

java.rmi.RemoteException

getFocusDevice

FocusDevice getFocusDevice()
                    throws DeviceException,
                           java.rmi.RemoteException

Returns the current default focus device.

Returns:

Focus device.

Throws:

DeviceException

java.rmi.RemoteException

getFocusDevices

FocusDevice[] getFocusDevices()
                       throws java.rmi.RemoteException

Returns a list of all installed focus devices.

Returns:

List of all installed focus devices.

Throws:

java.rmi.RemoteException

getFocusDevice

FocusDevice getFocusDevice(java.lang.String deviceID)
                    throws DeviceException,
                           java.rmi.RemoteException

Returns the focus device with the given name.

Parameters:

deviceID - Name of focus device.

Returns:

Focus device.

Throws:

DeviceException

java.rmi.RemoteException

setFocusDevice

void setFocusDevice(java.lang.String deviceID)
             throws DeviceException,
                    MicroscopeLockedException,
                    java.rmi.RemoteException

Sets the default focus device.

Parameters:

deviceID - Name of focus device.

Throws:

DeviceException

MicroscopeLockedException

java.rmi.RemoteException

setAutoFocusDevice

void setAutoFocusDevice(java.lang.String deviceID)
                 throws DeviceException,
                        MicroscopeLockedException,
                        java.rmi.RemoteException

Sets the default auto-focus device.

Parameters:

deviceID - Name of auto-focus device.

Throws:

DeviceException

MicroscopeLockedException

java.rmi.RemoteException

setShutterDevice

void setShutterDevice(java.lang.String deviceID)
               throws DeviceException,
                      MicroscopeLockedException,
                      java.rmi.RemoteException

Sets the default shutter device.

Parameters:

deviceID - Name of shutter device.

Throws:

DeviceException

MicroscopeLockedException

java.rmi.RemoteException

getShutterDevice

ShutterDevice getShutterDevice()
                        throws DeviceException,
                               java.rmi.RemoteException

Returns the current default shutter device.

Returns:

shutter device.

Throws:

DeviceException

java.rmi.RemoteException

getShutterDevices

ShutterDevice[] getShutterDevices()
                           throws java.rmi.RemoteException

Returns a list of all installed shutter devices.

Returns:

List of all installed shutter devices.

Throws:

java.rmi.RemoteException

getShutterDevice

ShutterDevice getShutterDevice(java.lang.String deviceID)
                        throws DeviceException,
                               java.rmi.RemoteException

Returns the shutter device with the given name.

Parameters:

deviceID - Name of shutter device.

Returns:

shutter device.

Throws:

DeviceException

java.rmi.RemoteException

getStageDevice

StageDevice getStageDevice()
                    throws DeviceException,
                           java.rmi.RemoteException

Returns the current default stage device.

Returns:

Stage device.

Throws:

DeviceException

java.rmi.RemoteException

getStageDevices

StageDevice[] getStageDevices()
                       throws java.rmi.RemoteException

Returns all installed stage devices.

Returns:

List of all stage devices.

Throws:

java.rmi.RemoteException

getStageDevice

StageDevice getStageDevice(java.lang.String deviceID)
                    throws DeviceException,
                           java.rmi.RemoteException

Returns the stage device with the given name.

Parameters:

deviceID - Name of stage device.

Returns:

Stage device.

Throws:

DeviceException

java.rmi.RemoteException

setStageDevice

void setStageDevice(java.lang.String deviceID)
             throws DeviceException,
                    MicroscopeLockedException,
                    java.rmi.RemoteException

Sets the default stage device.

Parameters:

deviceID - Name of stage device.

Throws:

DeviceException

MicroscopeLockedException

java.rmi.RemoteException

getCameraDevice

CameraDevice getCameraDevice()
                      throws DeviceException,
                             java.rmi.RemoteException

Returns the current default camera device.

Returns:

Device of the camera.

Throws:

DeviceException

java.rmi.RemoteException

setCameraDevice

void setCameraDevice(java.lang.String cameraDevice)
              throws DeviceException,
                     MicroscopeLockedException,
                     java.rmi.RemoteException

Sets the current default camera device.

Parameters:

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

Throws:

DeviceException

MicroscopeLockedException

java.rmi.RemoteException

getCameraDevices

CameraDevice[] getCameraDevices()
                         throws java.rmi.RemoteException

Returns all currently installed camera devices.

Returns:

All installed camera devices.

Throws:

java.rmi.RemoteException

getCameraDevice

CameraDevice getCameraDevice(java.lang.String name)
                      throws DeviceException,
                             java.rmi.RemoteException

Returns the camera device with the given name.

Parameters:

name - Name of the camera device.

Returns:

Device of the camera.

Throws:

DeviceException

java.rmi.RemoteException

getChannelManager

ChannelManager getChannelManager()
                          throws java.rmi.RemoteException

Returns an interface with which the current channel settings can be queried and a different channel can be set.

Returns:

the channel manager of the microscope.

Throws:

java.rmi.RemoteException

getPixelSizeManager

PixelSizeManager getPixelSizeManager()
                              throws java.rmi.RemoteException

Returns an interface with which the pixel size for different microscope settings can be queried and set.

Returns:

the pixel size manager of the microscope.

Throws:

java.rmi.RemoteException

applyDeviceSetting

void applyDeviceSetting(DeviceSetting setting)
                 throws SettingException,
                        MicroscopeLockedException,
                        java.rmi.RemoteException,
                        MicroscopeException,
                        java.lang.InterruptedException

Sets the given device property to the given value.

Parameters:

setting - Structure containing device, property and value configuration.

Throws:

SettingException

MicroscopeLockedException

java.rmi.RemoteException

MicroscopeException

java.lang.InterruptedException

applyDeviceSettings

void applyDeviceSettings(DeviceSetting[] settings)
                  throws SettingException,
                         java.rmi.RemoteException,
                         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.

Parameters:

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

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

applyDeviceSettingAsync

void applyDeviceSettingAsync(DeviceSetting setting)
                      throws SettingException,
                             MicroscopeLockedException,
                             MicroscopeException,
                             java.lang.InterruptedException,
                             java.rmi.RemoteException

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.

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

java.rmi.RemoteException

applyDeviceSettingsAsync

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

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.

Throws:

SettingException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

java.rmi.RemoteException

lockExclusiveWrite

void lockExclusiveWrite()
                 throws MicroscopeLockedException,
                        java.rmi.RemoteException

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.

Throws:

MicroscopeLockedException - Thrown if microscope is already locked for a longer time by somebody else.

java.rmi.RemoteException

unlockExclusiveWrite

void unlockExclusiveWrite()
                   throws MicroscopeLockedException,
                          java.rmi.RemoteException

Unlocks the previously acquired lock.

Throws:

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

java.rmi.RemoteException

loadConfiguration

java.lang.String loadConfiguration(RMIReader configurationReader)
                            throws MicroscopeConfigurationException,
                                   MicroscopeLockedException,
                                   java.rmi.RemoteException,
                                   java.lang.InterruptedException,
                                   MicroscopeException

Initializes the microscope with the configuration read from the reader (e.g. a FileReader to load a configuration file). If the configuration contained errors, a MicroscopeConfigurationException is thrown. If the configuration could be loaded, there still exists the possibility that YouScope believes that this configuration is not complete, belongs to a different version or was created by a different program, which all give a hint that the configuration process should be rerun. In this case a short message is passed as return value, giving a hint how should be proceeded, and which should be displayed to the user. If the configuration is believed to be complete and compatible, null is returned.

Parameters:

configurationReader - A reader to read in the configuration, e.g. a file reader.

Returns:

A message describing why this configuration may be defective, or null, if this configuration is believed to be not defective.

Throws:

MicroscopeConfigurationException

MicroscopeLockedException

java.rmi.RemoteException

MicroscopeException

java.lang.InterruptedException

saveConfiguration

void saveConfiguration(RMIWriter configurationWriter)
                throws MicroscopeConfigurationException,
                       java.rmi.RemoteException,
                       MicroscopeLockedException

Writes the current microscope configuration to the supplied writer (e.g. a file writer).

Parameters:

configurationWriter - The writer to which the configuration should be written.

Throws:

MicroscopeConfigurationException - Thrown if the configuration could not be generated.

java.rmi.RemoteException

MicroscopeLockedException

getLastConfigurationWarning

java.lang.String getLastConfigurationWarning()
                                      throws java.rmi.RemoteException

Returns the warning message generated and returned when loaded the last configuration, or null if no warning appeared. See return value of loadConfigFile(...);

Returns:

Last warning message when loading a configuration.

Throws:

java.rmi.RemoteException

uninitializeMicroscope

void uninitializeMicroscope()
                     throws MicroscopeException,
                            MicroscopeLockedException,
                            java.rmi.RemoteException,
                            java.lang.InterruptedException

Uninitializes the microscope. All loaded devices are unload.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

java.lang.InterruptedException

emergencyStop

void emergencyStop()
            throws java.rmi.RemoteException

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

Throws:

java.rmi.RemoteException

resetEmergencyStop

void resetEmergencyStop()
                 throws java.rmi.RemoteException

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

Throws:

java.rmi.RemoteException

isEmergencyStopped

boolean isEmergencyStopped()
                    throws java.rmi.RemoteException

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

Returns:

TRUE if emergency-stopped.

Throws:

java.rmi.RemoteException

addMessageListener

void addMessageListener(MessageListener listener)
                 throws java.rmi.RemoteException

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

Parameters:

listener - The listener.

Throws:

java.rmi.RemoteException

removeMessageListener

void removeMessageListener(MessageListener listener)
                    throws java.rmi.RemoteException

Removes a previously added listener.

Parameters:

listener - The listener.

Throws:

java.rmi.RemoteException

getStateDevice

StateDevice getStateDevice(java.lang.String name)
                    throws DeviceException,
                           java.rmi.RemoteException

Returns the state device with the given name.

Parameters:

name - Name of state device.

Returns:

State device.

Throws:

DeviceException

java.rmi.RemoteException

getStateDevices

StateDevice[] getStateDevices()
                       throws java.rmi.RemoteException

Returns a list of all installed state devices.

Returns:

List of all installed state devices.

Throws:

java.rmi.RemoteException

addConfigurationListener

void addConfigurationListener(MicroscopeConfigurationListener listener)
                       throws java.rmi.RemoteException

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

Parameters:

listener - Listener to add.

Throws:

java.rmi.RemoteException

removeConfigurationListener

void removeConfigurationListener(MicroscopeConfigurationListener listener)
                          throws java.rmi.RemoteException

Removes a previously added listener

Parameters:

listener - Listener to remove.

Throws:

java.rmi.RemoteException