org.youscope.addon.microscopeaccess

Interface ChannelInternal

public interface ChannelInternal

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	activateChannel(int accessID) Activates the channel, i.e.
void	closeShutter(int accessID) Closes the shutter associated to the channel.
void	deactivateChannel(int accessID) Deactivates the channel, i.e.
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.
void	openShutter(int accessID) Opens the shutter associated to the channel.

Method Detail

activateChannel

void activateChannel(int accessID)
              throws MicroscopeLockedException,
                     MicroscopeException,
                     java.lang.InterruptedException,
                     SettingException

Activates the channel, i.e. sets all device settings associated to the channel. Should be called before taking the first image in the channel.

Parameters:

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

SettingException

deactivateChannel

void deactivateChannel(int accessID)
                throws MicroscopeLockedException,
                       MicroscopeException,
                       java.lang.InterruptedException,
                       SettingException

Deactivates the channel, i.e. sets all device settings associated to stopping imaging in the respective channel. Should be called after taking the last image in the channel.

Parameters:

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

SettingException

openShutter

void openShutter(int accessID)
          throws MicroscopeLockedException,
                 MicroscopeException,
                 java.lang.InterruptedException,
                 SettingException,
                 DeviceException

Opens the shutter associated to the channel. Should be called directly before taking an image in the channel. Might be called more than once if taking more than one image, but with a certain delay between images. The shutter should be closed as soon as possible to minimize bleaching and similar. If no shutter is defined for this channel, does nothing.

Parameters:

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

SettingException

DeviceException

closeShutter

void closeShutter(int accessID)
           throws MicroscopeLockedException,
                  MicroscopeException,
                  java.lang.InterruptedException,
                  SettingException,
                  DeviceException

Closes the shutter associated to the channel. Should be called directly after taking one or many images in the channel. Might be called more than once if taking more than one image, but with a certain delay between images. The shutter should be closed as soon as possible to minimize bleaching and similar. If no shutter is defined for this channel, does nothing.

Parameters:

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

SettingException

DeviceException

getChannelGroupID

java.lang.String getChannelGroupID()

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

Returns:

ID of channel group.

getChannelID

java.lang.String getChannelID()

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

Returns:

ID of channel.