org.youscope.common.microscope

Interface PixelSize

All Superinterfaces:

java.rmi.Remote

public interface PixelSize
extends java.rmi.Remote

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addPixelSizeSetting(DeviceSetting setting) Adds a setting to the list of settings.
double	getPixelSize() Returns the pixel size in micro meters.
java.lang.String	getPixelSizeID() Returns the ID of the pixel size setting.
DeviceSetting[]	getPixelSizeSettings() Returns all device settings corresponding to this pixel size.
void	setPixelSize(double pixelSize) Sets the pixel size in micro meters.
void	setPixelSizeSettings(DeviceSetting[] newSettings) Sets all device settings corresponding to this pixel size.

Method Detail

getPixelSizeID

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

Returns the ID of the pixel size setting.

Returns:

The ID of the pixel size setting.

Throws:

java.rmi.RemoteException

getPixelSizeSettings

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

Returns all device settings corresponding to this pixel size.

Returns:

Set of device settings necessary for the pixel size setting to get active.

Throws:

java.rmi.RemoteException

setPixelSizeSettings

void setPixelSizeSettings(DeviceSetting[] newSettings)
                   throws MicroscopeLockedException,
                          SettingException,
                          java.rmi.RemoteException

Sets all device settings corresponding to this pixel size. All previously set settings get deleted.

Parameters:

newSettings - device settings which have to be active for this pixel size setting to be actual.

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

Throws:

MicroscopeLockedException

SettingException

java.rmi.RemoteException

addPixelSizeSetting

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

Adds a setting to the list of settings.

Parameters:

setting - Setting to add.

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

Throws:

MicroscopeLockedException

SettingException

java.rmi.RemoteException

getPixelSize

double getPixelSize()
             throws java.rmi.RemoteException

Returns the pixel size in micro meters.

Returns:

Pixel size in mico meters.

Throws:

java.rmi.RemoteException

setPixelSize

void setPixelSize(double pixelSize)
           throws MicroscopeLockedException,
                  SettingException,
                  java.rmi.RemoteException

Sets the pixel size in micro meters.

Parameters:

pixelSize - Pixel size in mico meters.

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

Throws:

MicroscopeLockedException

SettingException

java.rmi.RemoteException