org.youscope.common.microscope

Interface MicroscopeConfiguration

All Superinterfaces:

java.rmi.Remote

public interface MicroscopeConfiguration
extends java.rmi.Remote

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addImageSynchronizationDevice(java.lang.String device) Adds the given device to the list of image synchronization devices.
void	addSystemShutdownSetting(DeviceSetting setting) Adds a setting to the list of settings which will be applied at shutdown.
void	addSystemStartupSetting(DeviceSetting setting) Adds a setting to the list of settings which will be applied at startup.
int	getCommunicationPingPeriod() Gets the wait time used when pinging a device if a certain action is finished.
int	getCommunicationTimeout() Gets the timeout between in the communication with the devices.
int	getImageBufferSize() Returns the size of the internally used image buffer.
java.lang.String[]	getImageSynchronizationDevices() Returns the devices to which the microscope synchronizes when imaging.
DeviceSetting[]	getSystemShutdownSettings() Returns the settings which will be applied when the system shuts down.
DeviceSetting[]	getSystemStartupSettings() Returns the settings which will be applied when the system starts up.
void	removeImageSynchronizationDevice(java.lang.String device) Removes the given device to the list of image synchronization devices.
void	setCommunicationPingPeriod(int pingPeriod) Sets the wait time used when pinging a device if a certain action is finished.
void	setCommunicationTimeout(int timeout) Sets the timeout between in the communication with the devices.
void	setImageBufferSize(int sizeMB) Sets the size of an internally used image buffer.
void	setImageSynchronizationDevices(java.lang.String[] devices) Sets the devices for which the microscope waits before an image is made.
void	setSystemShutdownSettings(DeviceSetting[] settings) Set the setting which will be applied at shutdown.
void	setSystemStartupSettings(DeviceSetting[] settings) Set the setting which will be applied at startup.

Method Detail

setImageSynchronizationDevices

void setImageSynchronizationDevices(java.lang.String[] devices)
                             throws SettingException,
                                    java.rmi.RemoteException,
                                    MicroscopeLockedException

Sets the devices for which the microscope waits before an image is made. If devices is null, the microscope will not wait for any device.

Parameters:

devices - Devices to which the imaging process should synchronize, or null.

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

addImageSynchronizationDevice

void addImageSynchronizationDevice(java.lang.String device)
                            throws SettingException,
                                   java.rmi.RemoteException,
                                   MicroscopeLockedException

Adds the given device to the list of image synchronization devices.

Parameters:

device - Device to add to the image synchronization list.

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

removeImageSynchronizationDevice

void removeImageSynchronizationDevice(java.lang.String device)
                               throws SettingException,
                                      java.rmi.RemoteException,
                                      MicroscopeLockedException

Removes the given device to the list of image synchronization devices.

Parameters:

device - Device to remove from the image synchronization list.

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

getImageSynchronizationDevices

java.lang.String[] getImageSynchronizationDevices()
                                           throws java.rmi.RemoteException

Returns the devices to which the microscope synchronizes when imaging.

Returns:

List of synchronizing devices.

Throws:

java.rmi.RemoteException

getSystemStartupSettings

DeviceSetting[] getSystemStartupSettings()
                                  throws java.rmi.RemoteException

Returns the settings which will be applied when the system starts up.

Returns:

Settings applied at startup.

Throws:

java.rmi.RemoteException

setSystemStartupSettings

void setSystemStartupSettings(DeviceSetting[] settings)
                       throws java.rmi.RemoteException,
                              SettingException,
                              MicroscopeLockedException

Set the setting which will be applied at startup. If settings == null, no settings will be applied.

Parameters:

settings - Settings which will be applied at startup.

Throws:

java.rmi.RemoteException

SettingException

MicroscopeLockedException

addSystemStartupSetting

void addSystemStartupSetting(DeviceSetting setting)
                      throws java.rmi.RemoteException,
                             SettingException,
                             MicroscopeLockedException

Adds a setting to the list of settings which will be applied at startup. If the value of the device property is already defined by another setting, this overwrites the old setting.

Parameters:

setting - A setting which should be applied at startup.

Throws:

java.rmi.RemoteException

SettingException

MicroscopeLockedException

getCommunicationTimeout

int getCommunicationTimeout()
                     throws java.rmi.RemoteException

Gets the timeout between in the communication with the devices.

Returns:

Timeout in ms.

Throws:

java.rmi.RemoteException

setCommunicationTimeout

void setCommunicationTimeout(int timeout)
                      throws java.rmi.RemoteException,
                             SettingException,
                             MicroscopeLockedException

Sets the timeout between in the communication with the devices.

Parameters:

timeout - Timeout in ms.

Throws:

java.rmi.RemoteException

SettingException

MicroscopeLockedException

getCommunicationPingPeriod

int getCommunicationPingPeriod()
                        throws java.rmi.RemoteException

Gets the wait time used when pinging a device if a certain action is finished.

Returns:

Ping period in ms.

Throws:

java.rmi.RemoteException

setCommunicationPingPeriod

void setCommunicationPingPeriod(int pingPeriod)
                         throws java.rmi.RemoteException,
                                SettingException,
                                MicroscopeLockedException

Sets the wait time used when pinging a device if a certain action is finished.

Parameters:

pingPeriod - Ping period in ms.

Throws:

java.rmi.RemoteException

SettingException

MicroscopeLockedException

getSystemShutdownSettings

DeviceSetting[] getSystemShutdownSettings()
                                   throws java.rmi.RemoteException

Returns the settings which will be applied when the system shuts down.

Returns:

Settings applied at shutdown.

Throws:

java.rmi.RemoteException

setSystemShutdownSettings

void setSystemShutdownSettings(DeviceSetting[] settings)
                        throws SettingException,
                               java.rmi.RemoteException,
                               MicroscopeLockedException

Set the setting which will be applied at shutdown. If settings == null, no settings will be applied.

Parameters:

settings - Settings which will be applied at shutdown.

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

addSystemShutdownSetting

void addSystemShutdownSetting(DeviceSetting setting)
                       throws SettingException,
                              java.rmi.RemoteException,
                              MicroscopeLockedException

Adds a setting to the list of settings which will be applied at shutdown. If the value of the device property is already defined by another setting, this overwrites the old setting.

Parameters:

setting - A setting which should be applied at shutdown.

Throws:

SettingException

java.rmi.RemoteException

MicroscopeLockedException

setImageBufferSize

void setImageBufferSize(int sizeMB)
                 throws java.rmi.RemoteException,
                        SettingException,
                        MicroscopeLockedException,
                        java.lang.UnsupportedOperationException

Sets the size of an internally used image buffer. Note that this function might not be used for any implementation.

Parameters:

sizeMB - Size of the image buffer, in MB.

Throws:

java.rmi.RemoteException

SettingException

MicroscopeLockedException

java.lang.UnsupportedOperationException - Thrown if no image buffer is supported by this implementation.

getImageBufferSize

int getImageBufferSize()
                throws java.lang.UnsupportedOperationException,
                       java.rmi.RemoteException

Returns the size of the internally used image buffer. Note that this function might not be used for any implementation. Returns -1 if the image buffer size was not set, yet, or if a default value is used.

Returns:

Size in MB.

Throws:

java.lang.UnsupportedOperationException - Thrown if no image buffer is supported by this implementation.

java.rmi.RemoteException