org.youscope.addon.microscopeaccess

Interface FloatPropertyInternal

All Superinterfaces:

PropertyInternal

public interface FloatPropertyInternal
extends PropertyInternal

Author:

Moritz Lang

Property Summary

Properties inherited from interface org.youscope.addon.microscopeaccess.PropertyInternal

isPreInitializationProperty

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, int accessID) Sets the current value of the property.
void	setValueRelative(float offset, int accessID) Sets the value of the microscope relative to its current value.

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

getDeviceID, getPropertyID, getType, getValue, isEditable, isPreInitializationProperty, setValue

Method Detail

getFloatValue

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

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

setValue

void setValue(float value,
              int accessID)
       throws MicroscopeException,
              MicroscopeLockedException,
              java.lang.InterruptedException

Sets the current value of the property.

Parameters:

value - Value to set the property to.

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

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

setValueRelative

void setValueRelative(float offset,
                      int accessID)
               throws MicroscopeException,
                      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.

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

Throws:

MicroscopeException

MicroscopeLockedException

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

java.lang.InterruptedException

getLowerLimit

float getLowerLimit()

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.

getUpperLimit

float getUpperLimit()

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.