org.youscope.common.microscope

Interface IntegerProperty

All Superinterfaces:

Property, java.rmi.Remote

public interface IntegerProperty
extends Property

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
int	getIntegerValue() Returns the current value of the device property as an integer.
int	getLowerLimit() Returns the lower limit of this value.
int	getUpperLimit() Returns the upper limit of this value.
void	setValue(int value) Sets the current value of the property.
void	setValueRelative(int offset) Sets the value of the microscope relative to its current value.

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

getDeviceID, getPropertyID, getType, getValue, isEditable, setValue

Method Detail

getIntegerValue

int getIntegerValue()
             throws MicroscopeException,
                    java.lang.NumberFormatException,
                    java.lang.InterruptedException,
                    java.rmi.RemoteException

Returns the current value of the device property as an integer.

Returns:

Value of property.

Throws:

MicroscopeException

java.lang.NumberFormatException - Thrown when value is not an integer.

java.lang.InterruptedException

java.rmi.RemoteException

setValue

void setValue(int value)
       throws MicroscopeException,
              MicroscopeLockedException,
              java.lang.InterruptedException,
              java.rmi.RemoteException

Sets the current value of the property.

Parameters:

value - Value to set the property to.

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

java.rmi.RemoteException

setValueRelative

void setValueRelative(int offset)
               throws MicroscopeException,
                      MicroscopeLockedException,
                      java.lang.NumberFormatException,
                      java.lang.InterruptedException,
                      java.rmi.RemoteException

Sets the value of the microscope relative to its current value. Throws a NumberFormatException if the current value does not correspond to an integer value.

Parameters:

offset - Amount for which the current value should be changed.

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.NumberFormatException - Thrown when current value is not an integer.

java.lang.InterruptedException

java.rmi.RemoteException

getLowerLimit

int getLowerLimit()
           throws java.rmi.RemoteException

Returns the lower limit of this value. Returns Integer.MIN_VALUE if this property does not have limits.

Returns:

Minimal value this property can have.

Throws:

java.rmi.RemoteException

getUpperLimit

int getUpperLimit()
           throws java.rmi.RemoteException

Returns the upper limit of this value. Returns Integer.MAX_VALUE if this property does not have limits.

Returns:

Maximal value this property can have.

Throws:

java.rmi.RemoteException