org.youscope.common.microscope

Interface FloatProperty

All Superinterfaces:

Property, java.rmi.Remote

public interface FloatProperty
extends Property

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
float	getFloatValue() Returns the current value of the device property as a float.
float	getLowerLimit() Returns the lower limit of this value.
float	getUpperLimit() Returns the upper limit of this value.
void	setValue(float value) Sets the current value of the property.
void	setValueRelative(float 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

getFloatValue

float getFloatValue()
             throws MicroscopeException,
                    java.lang.NumberFormatException,
                    java.lang.InterruptedException,
                    java.rmi.RemoteException

Returns the current value of the device property as a float.

Returns:

Value of property.

Throws:

MicroscopeException

java.lang.NumberFormatException - Thrown when value is not a float.

java.lang.InterruptedException

java.rmi.RemoteException

setValue

void setValue(float 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(float offset)
               throws MicroscopeException,
                      java.rmi.RemoteException,
                      MicroscopeLockedException,
                      java.lang.NumberFormatException,
                      java.lang.InterruptedException

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

Parameters:

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

Throws:

MicroscopeException

java.rmi.RemoteException

MicroscopeLockedException

java.lang.NumberFormatException - Thrown when current value is not a float.

java.lang.InterruptedException

getLowerLimit

float getLowerLimit()
             throws java.rmi.RemoteException

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

Returns:

Minimal value this property can have.

Throws:

java.rmi.RemoteException

getUpperLimit

float getUpperLimit()
             throws java.rmi.RemoteException

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

Returns:

Maximal value this property can have.

Throws:

java.rmi.RemoteException