org.youscope.common.microscope

Interface ChannelManager

All Superinterfaces:

java.rmi.Remote

public interface ChannelManager
extends java.rmi.Remote

Allows access to the current microscope channel settings.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
Channel	addChannel(java.lang.String channelGroupID, java.lang.String channelID) Adds the channel in the given config group.
Channel	getChannel(java.lang.String channelGroupID, java.lang.String channelID) Returns the channel with the given ID and channel group ID.
java.lang.String[]	getChannelGroupIDs() Returns a list of all available config groups (e.g.
Channel[]	getChannels() Returns all channels.
Channel[]	getChannels(java.lang.String channelGroupID) Returns all channels in the given channel group.
void	removeChannel(java.lang.String channelGroupID, java.lang.String channelID) Removes the channel in the given channel group.

Method Detail

getChannelGroupIDs

java.lang.String[] getChannelGroupIDs()
                               throws java.rmi.RemoteException

Returns a list of all available config groups (e.g. the channel group).

Returns:

List of all config groups.

Throws:

java.rmi.RemoteException

getChannels

Channel[] getChannels(java.lang.String channelGroupID)
               throws SettingException,
                      java.rmi.RemoteException

Returns all channels in the given channel group.

Parameters:

channelGroupID - The ID of channel group for which the IDs of the contained channels should be returned..

Returns:

Channels.

Throws:

SettingException

java.rmi.RemoteException

getChannels

Channel[] getChannels()
               throws java.rmi.RemoteException

Returns all channels.

Parameters:

channelGroupID - The ID of channel group for which the IDs of the contained channels should be returned..

Returns:

Channels.

Throws:

java.rmi.RemoteException

getChannel

Channel getChannel(java.lang.String channelGroupID,
                   java.lang.String channelID)
            throws SettingException,
                   java.rmi.RemoteException

Returns the channel with the given ID and channel group ID. Returns null if either the channel group or the channel id is null.

Parameters:

channelGroupID - The channel group where the channel is defined.

channelID - The ID of the channel.

Returns:

The channel.

Throws:

SettingException - Thrown if the channel is not defined.

java.rmi.RemoteException

addChannel

Channel addChannel(java.lang.String channelGroupID,
                   java.lang.String channelID)
            throws MicroscopeLockedException,
                   SettingException,
                   java.rmi.RemoteException

Adds the channel in the given config group. If the channel and/or the config group do not exist, they are created. If the channel does already exist, it is returned.

Parameters:

channelGroupID - The config group where the channel should be created.

channelID - The name of the channel.

Returns:

The newly added channel.

Throws:

MicroscopeLockedException

SettingException

java.rmi.RemoteException

removeChannel

void removeChannel(java.lang.String channelGroupID,
                   java.lang.String channelID)
            throws MicroscopeLockedException,
                   SettingException,
                   java.rmi.RemoteException

Removes the channel in the given channel group. If either the channel or the channel group do not exist, a setting exception is thrown.

Parameters:

channelGroupID - The group in which the channel is defined.

channelID - The ID of the channel.

Throws:

MicroscopeLockedException

SettingException

java.rmi.RemoteException