org.youscope.common.microscope

Interface Channel

All Superinterfaces:

java.rmi.Remote

public interface Channel
extends java.rmi.Remote

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addChannelOffSetting(DeviceSetting setting) Adds a setting to the list of settings which get deactivated if this channel gets deactivated.
void	addChannelOnSetting(DeviceSetting setting) Adds a setting to the list of settings which get activated if this channel gets activated.
java.lang.String	getChannelGroupID() Returns the ID of the channel group where this channel belongs to.
java.lang.String	getChannelID() Returns the ID of this channel.
DeviceSetting[]	getChannelOffSettings() Returns all device settings which get set if this channel is deactivated.
DeviceSetting[]	getChannelOnSettings() Returns all device settings which get set if this channel is activated.
int	getChannelTimeout() Returns the current timeout when changing a channel.
java.lang.String	getShutter() Returns the device ID of the shutter of this channel.
void	setChannelOffSettings(DeviceSetting[] settings) Sets all device settings which get set if this channel is deactivated.
void	setChannelOnSettings(DeviceSetting[] settings) Sets all device settings which get set if this channel is activated.
void	setChannelTimeout(int timeOutInMillis) Sets a timeout when changing the channel for synchronization purposes.
void	setShutter(java.lang.String deviceID) Sets the shutter device of this channel.

Method Detail

getChannelOnSettings

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

Returns all device settings which get set if this channel is activated.

Returns:

Set of device settings which get set if this channel is activated.

Throws:

java.rmi.RemoteException

getChannelOffSettings

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

Returns all device settings which get set if this channel is deactivated.

Returns:

Set of device settings which get set if this channel is activated.

Throws:

java.rmi.RemoteException

setChannelOnSettings

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

Sets all device settings which get set if this channel is activated. All previous settings get deleted.

Parameters:

settings - New settings for the channel.

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

setChannelOffSettings

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

Sets all device settings which get set if this channel is deactivated. All previous settings get deleted.

Parameters:

settings - New settings for the channel.

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

addChannelOnSetting

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

Adds a setting to the list of settings which get activated if this channel gets activated.

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

addChannelOffSetting

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

Adds a setting to the list of settings which get deactivated if this channel gets deactivated.

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

getChannelGroupID

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

Returns the ID of the channel group where this channel belongs to.

Returns:

ID of channel group.

Throws:

java.rmi.RemoteException

getChannelID

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

Returns the ID of this channel. Together with the channel group ID, this ID identifies this channel.

Returns:

ID of channel.

Throws:

java.rmi.RemoteException

setChannelTimeout

void setChannelTimeout(int timeOutInMillis)
                throws MicroscopeLockedException,
                       java.rmi.RemoteException

Sets a timeout when changing the channel for synchronization purposes. After activating the channel on setting, and before imaging the microscope will be blocked for the given time

Parameters:

timeOutInMillis - The timeout (wait) 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:

MicroscopeLockedException

java.rmi.RemoteException

getChannelTimeout

int getChannelTimeout()
               throws java.rmi.RemoteException

Returns the current timeout when changing a channel.

Returns:

Current timeout (default = 0).

Throws:

java.rmi.RemoteException

setShutter

void setShutter(java.lang.String deviceID)
         throws SettingException,
                MicroscopeLockedException,
                java.rmi.RemoteException

Sets the shutter device of this channel. The shutter is automatically opened shortly before the image process and closed afterwards. Set to null if the shutter should not be opened and closed automatically.

Parameters:

deviceID - The device ID of the shutter.

Throws:

SettingException

MicroscopeLockedException

java.rmi.RemoteException

getShutter

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

Returns the device ID of the shutter of this channel. The shutter is automatically opened shortly before the image process and closed afterwards. Returns null if the shutter is not be opened and closed automatically.

Returns:

The device ID of the shutter associated to this device.

Throws:

java.rmi.RemoteException