org.youscope.addon.microscopeaccess

Interface StateDeviceInternal

All Superinterfaces:

DeviceInternal

public interface StateDeviceInternal
extends DeviceInternal

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, int accessID) Sets the current state.
void	setState(java.lang.String label, int accessID) Sets the current state.
void	setStateLabel(int state, java.lang.String label, int accessID) Sets the label for the given state.
void	setStateLabels(java.lang.String[] labels, int accessID) Sets all state labels.

Methods inherited from interface org.youscope.addon.microscopeaccess.DeviceInternal

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

Method Detail

getNumStates

int getNumStates()

Returns the number of states.

Returns:

Number of states.

getState

int getState()
      throws MicroscopeException

Returns the current state.

Returns:

Current state.

Throws:

MicroscopeException

getStateLabels

java.lang.String[] getStateLabels()

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.

getStateLabel

java.lang.String getStateLabel()
                        throws MicroscopeException

Returns the current state label.

Returns:

Current state label.

Throws:

MicroscopeException

getStateLabel

java.lang.String getStateLabel(int state)
                        throws java.lang.ArrayIndexOutOfBoundsException

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

setStateLabel

void setStateLabel(int state,
                   java.lang.String label,
                   int accessID)
            throws java.lang.ArrayIndexOutOfBoundsException,
                   MicroscopeException,
                   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.

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

Throws:

java.lang.ArrayIndexOutOfBoundsException

MicroscopeException

MicroscopeLockedException

setStateLabels

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

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

Parameters:

labels - New labels for the states.

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

Throws:

MicroscopeException

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

MicroscopeLockedException

setState

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

Sets the current state.

Parameters:

state - State which should be set.

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

Throws:

MicroscopeException

java.lang.ArrayIndexOutOfBoundsException

MicroscopeLockedException

setState

void setState(java.lang.String label,
              int accessID)
       throws MicroscopeException,
              DeviceException,
              MicroscopeLockedException

Sets the current state.

Parameters:

label - Label of the state which should be set.

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

Throws:

MicroscopeException

DeviceException - Thrown if label is unknown.

MicroscopeLockedException