org.youscope.addon.microscopeaccess

Interface MicroscopeConfigurationInternal

public interface MicroscopeConfigurationInternal

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addImageSynchronizationDevice(java.lang.String device, int accessID) Adds the given device to the list of image synchronization devices.
void	addSystemShutdownSetting(DeviceSetting setting, int accessID) Adds a setting to the list of settings which will be applied at shutdown.
void	addSystemStartupSetting(DeviceSetting setting, int accessID) 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, int accessID) Removes the given device to the list of image synchronization devices.
void	setCommunicationPingPeriod(int pingPeriod, int accessID) Sets the wait time used when pinging a device if a certain action is finished.
void	setCommunicationTimeout(int timeout, int accessID) Sets the timeout between in the communication with the devices.
void	setImageBufferSize(int sizeMB, int accessID) Sets the size of an internally used image buffer.
void	setImageSynchronizationDevices(java.lang.String[] devices, int accessID) Sets the devices for which the microscope waits before an image is made.
void	setSystemShutdownSettings(DeviceSetting[] settings, int accessID) Set the setting which will be applied at shutdown.
void	setSystemStartupSettings(DeviceSetting[] settings, int accessID) Set the setting which will be applied at startup.

Method Detail

setImageSynchronizationDevices

void setImageSynchronizationDevices(java.lang.String[] devices,
                                    int accessID)
                             throws SettingException,
                                    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:

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

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

Throws:

SettingException

MicroscopeLockedException

addImageSynchronizationDevice

void addImageSynchronizationDevice(java.lang.String device,
                                   int accessID)
                            throws SettingException,
                                   MicroscopeLockedException

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

Parameters:

device - Device to add to the image synchronization list.

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

removeImageSynchronizationDevice

void removeImageSynchronizationDevice(java.lang.String device,
                                      int accessID)
                               throws SettingException,
                                      MicroscopeLockedException

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

Parameters:

device - Device to remove from the image synchronization list.

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

getImageSynchronizationDevices

java.lang.String[] getImageSynchronizationDevices()

Returns the devices to which the microscope synchronizes when imaging.

Returns:

List of synchronizing devices.

getSystemStartupSettings

DeviceSetting[] getSystemStartupSettings()

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

Returns:

Settings applied at startup.

setSystemStartupSettings

void setSystemStartupSettings(DeviceSetting[] settings,
                              int accessID)
                       throws 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.

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

addSystemStartupSetting

void addSystemStartupSetting(DeviceSetting setting,
                             int accessID)
                      throws 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:

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

setting - A setting which should be applied at startup.

Throws:

SettingException

MicroscopeLockedException

getSystemShutdownSettings

DeviceSetting[] getSystemShutdownSettings()

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

Returns:

Settings applied at shutdown.

setSystemShutdownSettings

void setSystemShutdownSettings(DeviceSetting[] settings,
                               int accessID)
                        throws SettingException,
                               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.

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

addSystemShutdownSetting

void addSystemShutdownSetting(DeviceSetting setting,
                              int accessID)
                       throws SettingException,
                              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.

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

getCommunicationTimeout

int getCommunicationTimeout()

Gets the timeout between in the communication with the devices.

Returns:

Timeout in ms.

setCommunicationTimeout

void setCommunicationTimeout(int timeout,
                             int accessID)
                      throws SettingException,
                             MicroscopeLockedException

Sets the timeout between in the communication with the devices.

Parameters:

timeout - Timeout in ms.

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

setImageBufferSize

void setImageBufferSize(int sizeMB,
                        int accessID)
                 throws 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.

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

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

getImageBufferSize

int getImageBufferSize()
                throws java.lang.UnsupportedOperationException

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.

getCommunicationPingPeriod

int getCommunicationPingPeriod()

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

Returns:

Ping period in ms.

setCommunicationPingPeriod

void setCommunicationPingPeriod(int pingPeriod,
                                int accessID)
                         throws SettingException,
                                MicroscopeLockedException

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

Parameters:

pingPeriod - Ping period in ms.

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