org.youscope.addon.microscopeaccess

Interface FocusDeviceInternal

All Superinterfaces:

DeviceInternal

All Known Implementing Classes:

FocusDeviceImpl

public interface FocusDeviceInternal
extends DeviceInternal

Author:

langmo

Method Summary

Modifier and Type	Method and Description
double	getFocusPosition() Returns the position of the focus device.
void	setFocusPosition(double position, int accessID) Sets the position of the current focus device.
void	setRelativeFocusPosition(double offset, int accessID) Sets the position of the current focus device relative to the current focus.

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

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

Method Detail

getFocusPosition

double getFocusPosition()
                 throws MicroscopeException,
                        java.lang.InterruptedException

Returns the position of the focus device.

Returns:

Position of the focus device.

Throws:

MicroscopeException

java.lang.InterruptedException

setFocusPosition

void setFocusPosition(double position,
                      int accessID)
               throws MicroscopeLockedException,
                      MicroscopeException,
                      java.lang.InterruptedException

Sets the position of the current focus device.

Parameters:

position - The new position.

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

Throws:

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

setRelativeFocusPosition

void setRelativeFocusPosition(double offset,
                              int accessID)
                       throws MicroscopeLockedException,
                              MicroscopeException,
                              java.lang.InterruptedException

Sets the position of the current focus device relative to the current focus.

Parameters:

offset - The offset.

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

Throws:

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException