org.youscope.common.microscope

Interface StateDevice

All Superinterfaces:

Device, java.rmi.Remote

public interface StateDevice
extends Device

Author:

langmo

Method Summary

Modifier and Type	Method and Description
int	getNumStates() Returns the number of states.
int	getState() Returns the current state.
java.lang.String	getStateLabel() Returns the current state label.
java.lang.String	getStateLabel(int state) Returns the label of the given state.
java.lang.String[]	getStateLabels() Returns a list of all labels of the states of this device.
void	setState(int state) Sets the current state.
void	setState(java.lang.String label) Sets the current state.
void	setStateLabel(int state, java.lang.String label) Sets the label for the given state.
void	setStateLabels(java.lang.String[] labels) Sets all state labels.

Methods inherited from interface org.youscope.common.microscope.Device

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

Method Detail

getNumStates

int getNumStates()
          throws java.rmi.RemoteException

Returns the number of states.

Returns:

Number of states.

Throws:

java.rmi.RemoteException

getState

int getState()
      throws MicroscopeException,
             java.rmi.RemoteException

Returns the current state.

Returns:

Current state.

Throws:

MicroscopeException

java.rmi.RemoteException

getStateLabels

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

Returns a list of all labels of the states of this device. The list has the same length as getNumStates().

Returns:

List of state labels.

Throws:

java.rmi.RemoteException

getStateLabel

java.lang.String getStateLabel()
                        throws MicroscopeException,
                               java.rmi.RemoteException

Returns the current state label.

Returns:

Current state label.

Throws:

MicroscopeException

java.rmi.RemoteException

getStateLabel

java.lang.String getStateLabel(int state)
                        throws java.lang.ArrayIndexOutOfBoundsException,
                               java.rmi.RemoteException

Returns the label of the given state.

Parameters:

state - State for which the label should be queried.

Returns:

Label of state.

Throws:

java.lang.ArrayIndexOutOfBoundsException

java.rmi.RemoteException

setStateLabel

void setStateLabel(int state,
                   java.lang.String label)
            throws MicroscopeException,
                   java.lang.ArrayIndexOutOfBoundsException,
                   java.rmi.RemoteException,
                   MicroscopeLockedException

Sets the label for the given state.

Parameters:

state - The state for which the label should be set

label - The label for the state.

Throws:

MicroscopeException

java.lang.ArrayIndexOutOfBoundsException

java.rmi.RemoteException

MicroscopeLockedException

setStateLabels

void setStateLabels(java.lang.String[] labels)
             throws MicroscopeException,
                    java.lang.ArrayIndexOutOfBoundsException,
                    java.rmi.RemoteException,
                    MicroscopeLockedException

Sets all state labels. The number of labels must be exactly equal to getNumStates().

Parameters:

labels - New labels for the states.

Throws:

MicroscopeException

java.rmi.RemoteException

java.lang.ArrayIndexOutOfBoundsException - Thrown if length of labels is wrong, in one or the other direction.

MicroscopeLockedException

setState

void setState(int state)
       throws MicroscopeException,
              java.lang.ArrayIndexOutOfBoundsException,
              java.rmi.RemoteException,
              MicroscopeLockedException

Sets the current state.

Parameters:

state - State which should be set.

Throws:

MicroscopeException

java.lang.ArrayIndexOutOfBoundsException

java.rmi.RemoteException

MicroscopeLockedException

setState

void setState(java.lang.String label)
       throws MicroscopeException,
              DeviceException,
              java.rmi.RemoteException,
              MicroscopeLockedException

Sets the current state.

Parameters:

label - Label of the state which should be set.

Throws:

MicroscopeException

java.rmi.RemoteException

DeviceException - Thrown if label is unknown.

MicroscopeLockedException